From 075f4e31a227a8047309dfb1d1e142cfeca8b5c5 Mon Sep 17 00:00:00 2001 From: Volker Scheuber Date: Tue, 24 Feb 2026 08:53:26 -0700 Subject: [PATCH 1/3] Fix header overrides not being applied. (#548) --- src/api/BaseApi.ts | 192 ++++++++++++++++++++++---------- src/ops/ConnectionProfileOps.ts | 17 ++- 2 files changed, 145 insertions(+), 64 deletions(-) diff --git a/src/api/BaseApi.ts b/src/api/BaseApi.ts index d0ec8d50c..cf50cc31a 100644 --- a/src/api/BaseApi.ts +++ b/src/api/BaseApi.ts @@ -12,7 +12,7 @@ import { ProxyAgent } from 'proxy-agent'; import _curlirize from '../ext/axios-curlirize/curlirize'; import StateImpl, { State } from '../shared/State'; import { getUserAgent } from '../shared/Version'; -import { curlirizeMessage, printMessage } from '../utils/Console'; +import { curlirizeMessage, debugMessage, printMessage } from '../utils/Console'; import { mergeDeep } from '../utils/JsonUtils'; import { setupPollyForFrodoLib } from '../utils/SetupPollyForFrodoLib'; @@ -216,6 +216,15 @@ export function generateAmApi({ requestOverride ); + debugMessage({ + message: `Generating AM API client for resource with request headers ${JSON.stringify( + requestConfig.headers, + null, + 2 + )}`, + state, + }); + const request = createAxiosInstance(state, requestConfig); // enable curlirizer output in debug mode @@ -247,7 +256,7 @@ export function generateOauth2Api({ authenticate?: boolean; state: State; }): AxiosInstance { - let headers: { [key: string]: any } = { + const headers: { [key: string]: any } = { 'User-Agent': userAgent, 'X-ForgeRock-TransactionId': transactionId, // only add API version if we have it @@ -266,28 +275,33 @@ export function generateOauth2Api({ Authorization: `Bearer ${state.getBearerToken()}`, }), }; - if (requestOverride['headers']) { - headers = { - ...headers, - ...requestOverride['headers'], - }; - } - const requestConfig = { - // baseURL: `${storage.session.getTenant()}/json${resource.path}`, - timeout, - ...requestOverride, - headers: { - ...headers, - ...state.getAuthenticationHeaderOverrides(), + const requestConfig = mergeDeep( + { + // baseURL: `${storage.session.getTenant()}/json${resource.path}`, + timeout, + headers: { + ...headers, + ...state.getAuthenticationHeaderOverrides(), + }, + ...(process.env.FRODO_MOCK !== 'record' && + process.env.FRODO_POLLY_MODE !== 'record' && { + httpAgent: getHttpAgent(), + httpsAgent: getHttpsAgent(state.getAllowInsecureConnection()), + }), + proxy: getProxy(), }, - ...(process.env.FRODO_MOCK !== 'record' && - process.env.FRODO_POLLY_MODE !== 'record' && { - httpAgent: getHttpAgent(), - httpsAgent: getHttpsAgent(state.getAllowInsecureConnection()), - }), - proxy: getProxy(), - }; + requestOverride + ); + + debugMessage({ + message: `Generating OAuth2 API client for resource with request headers ${JSON.stringify( + requestConfig.headers, + null, + 2 + )}`, + state, + }); const request = createAxiosInstance(state, requestConfig); @@ -339,6 +353,15 @@ export function generateIdmApi({ requestOverride ); + debugMessage({ + message: `Generating IDM API client for resource with request headers ${JSON.stringify( + requestConfig.headers, + null, + 2 + )}`, + state, + }); + const request = createAxiosInstance(state, requestConfig); // enable curlirizer output in debug mode @@ -385,6 +408,15 @@ export function generateLogKeysApi({ requestOverride ); + debugMessage({ + message: `Generating LogKeys API client for resource with request headers ${JSON.stringify( + requestConfig.headers, + null, + 2 + )}`, + state, + }); + const request = createAxiosInstance(state, requestConfig); // enable curlirizer output in debug mode @@ -431,6 +463,15 @@ export function generateLogApi({ requestOverride ); + debugMessage({ + message: `Generating Log API client for resource with request headers ${JSON.stringify( + requestConfig.headers, + null, + 2 + )}`, + state, + }); + const request = createAxiosInstance(state, requestConfig); // add a response interceptor for HTTP 429 errors from log API @@ -508,18 +549,29 @@ export function generateEnvApi({ Authorization: `Bearer ${state.getBearerToken()}`, }), }; - const requestConfig = { - // baseURL: getTenantURL(storage.session.getTenant()), - timeout, - headers, - ...requestOverride, - ...(process.env.FRODO_MOCK !== 'record' && - process.env.FRODO_POLLY_MODE !== 'record' && { - httpAgent: getHttpAgent(), - httpsAgent: getHttpsAgent(state.getAllowInsecureConnection()), - }), - proxy: getProxy(), - }; + const requestConfig = mergeDeep( + { + // baseURL: getTenantURL(storage.session.getTenant()), + timeout, + headers, + ...(process.env.FRODO_MOCK !== 'record' && + process.env.FRODO_POLLY_MODE !== 'record' && { + httpAgent: getHttpAgent(), + httpsAgent: getHttpsAgent(state.getAllowInsecureConnection()), + }), + proxy: getProxy(), + }, + requestOverride + ); + + debugMessage({ + message: `Generating Environment API client for resource with request headers ${JSON.stringify( + requestConfig.headers, + null, + 2 + )}`, + state, + }); const request = createAxiosInstance(state, requestConfig); @@ -561,17 +613,28 @@ export function generateGovernanceApi({ Authorization: `Bearer ${state.getBearerToken()}`, }), }; - const requestConfig = { - timeout, - headers, - ...requestOverride, - ...(process.env.FRODO_MOCK !== 'record' && - process.env.FRODO_POLLY_MODE !== 'record' && { - httpAgent: getHttpAgent(), - httpsAgent: getHttpsAgent(state.getAllowInsecureConnection()), - }), - proxy: getProxy(), - }; + const requestConfig = mergeDeep( + { + timeout, + headers, + ...(process.env.FRODO_MOCK !== 'record' && + process.env.FRODO_POLLY_MODE !== 'record' && { + httpAgent: getHttpAgent(), + httpsAgent: getHttpsAgent(state.getAllowInsecureConnection()), + }), + proxy: getProxy(), + }, + requestOverride + ); + + debugMessage({ + message: `Generating Governance API client for resource with request headers ${JSON.stringify( + requestConfig.headers, + null, + 2 + )}`, + state, + }); const request = createAxiosInstance(state, requestConfig); @@ -601,21 +664,32 @@ export function generateReleaseApi({ requestOverride?: AxiosRequestConfig; state: State; }): AxiosInstance { - const requestConfig = { - baseURL: baseUrl, - timeout, - headers: { - 'User-Agent': userAgent, - 'Content-Type': 'application/json', + const requestConfig = mergeDeep( + { + baseURL: baseUrl, + timeout, + headers: { + 'User-Agent': userAgent, + 'Content-Type': 'application/json', + }, + ...(process.env.FRODO_MOCK !== 'record' && + process.env.FRODO_POLLY_MODE !== 'record' && { + httpAgent: getHttpAgent(), + httpsAgent: getHttpsAgent(state.getAllowInsecureConnection()), + }), + proxy: getProxy(), }, - ...requestOverride, - ...(process.env.FRODO_MOCK !== 'record' && - process.env.FRODO_POLLY_MODE !== 'record' && { - httpAgent: getHttpAgent(), - httpsAgent: getHttpsAgent(state.getAllowInsecureConnection()), - }), - proxy: getProxy(), - }; + requestOverride + ); + + debugMessage({ + message: `Generating Release API client for resource with request headers ${JSON.stringify( + requestConfig.headers, + null, + 2 + )}`, + state, + }); const request = createAxiosInstance(state, requestConfig); diff --git a/src/ops/ConnectionProfileOps.ts b/src/ops/ConnectionProfileOps.ts index 4ec4ef92e..c7298d351 100644 --- a/src/ops/ConnectionProfileOps.ts +++ b/src/ops/ConnectionProfileOps.ts @@ -16,6 +16,7 @@ import { } from './cloud/ServiceAccountOps'; import { FrodoError } from './FrodoError'; import { createJwkRsa, createJwks, getJwkRsaPublic, JwkRsa } from './JoseOps'; +import { mergeDeep } from '../utils/JsonUtils'; export type ConnectionProfile = { /** @@ -458,6 +459,10 @@ export async function getConnectionProfileByHost({ ? await dataProtection.decrypt(profiles[0].encodedAmsterPrivateKey) : null, }; + debugMessage({ + message: `ConnectionProfileOps.getConnectionProfileByHost: retrieved connection profile for host '${host}': ${JSON.stringify(connectionProfile, null, 2)}`, + state, + }); return connectionProfile; } catch (error) { throw new FrodoError(`Error decrypting connection profile`, error); @@ -509,11 +514,13 @@ export async function loadConnectionProfileByHost({ if (conn.authenticationService && !state.getAuthenticationService()) { state.setAuthenticationService(conn.authenticationService); } - if ( - conn.authenticationHeaderOverrides && - !state.getAuthenticationHeaderOverrides() - ) { - state.setAuthenticationHeaderOverrides(conn.authenticationHeaderOverrides); + if (conn.authenticationHeaderOverrides) { + state.setAuthenticationHeaderOverrides( + mergeDeep( + state.getAuthenticationHeaderOverrides(), + conn.authenticationHeaderOverrides + ) + ); } state.setServiceAccountId(conn.svcacctId); state.setServiceAccountJwk(conn.svcacctJwk); From f24d8de6574c361aa8653ae28112cc5efb606466 Mon Sep 17 00:00:00 2001 From: "github-actions[bot]" <41898282+github-actions[bot]@users.noreply.github.com> Date: Tue, 24 Feb 2026 15:58:50 +0000 Subject: [PATCH 2/3] Updated changelog, version, and docs for release v4.0.0-11 --- CHANGELOG.md | 5 +- docs/classes/FrodoError.html | 6 +- docs/enums/Reference.EnforcementGroup.html | 4 +- docs/hierarchy.html | 2 +- docs/index.html | 4 +- ...erence.AdminFederationExportInterface.html | 4 +- .../Reference.AgentExportInterface.html | 4 +- .../Reference.AgentGroupExportInterface.html | 4 +- .../Reference.AmConfigEntitiesInterface.html | 4 +- .../Reference.AmConfigEntityInterface.html | 4 +- .../Reference.ApplicationExportInterface.html | 18 +-- ...AuthenticationSettingsExportInterface.html | 4 +- ...ference.CirclesOfTrustExportInterface.html | 4 +- ...ference.ConfigEntityExportInterface-1.html | 4 +- ...Reference.ConfigEntityExportInterface.html | 4 +- .../Reference.ConfigEntityExportOptions.html | 8 +- .../Reference.ConfigEntityImportOptions.html | 10 +- .../Reference.ConnectionProfileInterface.html | 4 +- .../Reference.ConnectionsFileInterface.html | 2 +- .../Reference.ConnectorExportInterface.html | 4 +- .../Reference.ConnectorExportOptions.html | 8 +- .../Reference.ConnectorImportOptions.html | 6 +- ...erence.ConnectorServerStatusInterface.html | 4 +- .../Reference.CustomNodeExportInterface.html | 4 +- .../Reference.CustomNodeExportOptions.html | 6 +- .../Reference.CustomNodeImportOptions.html | 8 +- ...eference.EmailTemplateExportInterface.html | 4 +- .../Reference.EnvInfoInterface.html | 4 +- docs/interfaces/Reference.ExportMetaData.html | 4 +- .../Reference.FeatureInterface.html | 4 +- .../Reference.FullExportInterface.html | 4 +- .../Reference.FullExportOptions.html | 22 ++-- .../Reference.FullGlobalExportInterface.html | 4 +- .../Reference.FullImportOptions.html | 18 +-- .../Reference.FullRealmExportInterface.html | 4 +- docs/interfaces/Reference.FullService.html | 4 +- .../Reference.IdObjectSkeletonInterface.html | 4 +- ...ference.InnerNodeRefSkeletonInterface.html | 4 +- ...Reference.InternalRoleExportInterface.html | 8 +- docs/interfaces/Reference.JwkInterface.html | 4 +- docs/interfaces/Reference.JwksInterface.html | 4 +- .../Reference.MappingExportInterface.html | 4 +- .../Reference.MappingExportOptions.html | 12 +- .../Reference.MappingImportOptions.html | 6 +- .../Reference.MultiTreeExportInterface.html | 4 +- ...Reference.NoIdObjectSkeletonInterface.html | 4 +- .../Reference.NodeExportInterface.html | 4 +- .../Reference.NodeRefSkeletonInterface.html | 4 +- ...Reference.OAuth2ClientExportInterface.html | 4 +- .../Reference.OAuth2ClientExportOptions.html | 8 +- .../Reference.OAuth2ClientImportOptions.html | 6 +- ...OAuth2TrustedJwtIssuerExportInterface.html | 4 +- ...e.OAuth2TrustedJwtIssuerExportOptions.html | 8 +- ...e.OAuth2TrustedJwtIssuerImportOptions.html | 6 +- .../Reference.PatchOperationInterface.html | 6 +- .../Reference.PlatformInfoInterface.html | 4 +- .../Reference.PolicyExportInterface.html | 4 +- .../Reference.PolicyExportOptions.html | 10 +- .../Reference.PolicyImportOptions.html | 10 +- .../Reference.PolicySetExportInterface.html | 4 +- .../Reference.PolicySetExportOptions.html | 10 +- .../Reference.PolicySetImportOptions.html | 8 +- .../Reference.RawExportOptions.html | 10 +- .../Reference.RealmExportInterface.html | 4 +- ...Reference.ResourceTypeExportInterface.html | 4 +- .../Reference.Saml2EntitiesExportOptions.html | 4 +- .../Reference.Saml2EntitiesImportOptions.html | 4 +- .../Reference.Saml2ExportInterface.html | 4 +- .../Reference.ScriptExportInterface.html | 4 +- .../Reference.ScriptExportOptions.html | 10 +- .../Reference.ScriptImportOptions.html | 10 +- .../Reference.ScriptTypeExportInterface.html | 4 +- .../Reference.SecretStoreExportInterface.html | 4 +- .../Reference.SecretsExportInterface.html | 4 +- ...ence.SecureConnectionProfileInterface.html | 4 +- .../Reference.ServerExportInterface.html | 4 +- .../Reference.ServerExportOptions.html | 6 +- .../Reference.ServerImportOptions.html | 6 +- .../Reference.ServiceExportInterface.html | 4 +- .../Reference.ServiceImportOptions.html | 10 +- .../Reference.ServiceNextDescendent.html | 2 +- .../Reference.SingleTreeExportInterface.html | 4 +- .../Reference.SiteExportInterface.html | 4 +- ...e.SocialIdentityProviderExportOptions.html | 8 +- ...e.SocialIdentityProviderImportOptions.html | 6 +- ...ference.SocialProviderExportInterface.html | 4 +- docs/interfaces/Reference.StateInterface.html | 4 +- ...e.SystemObjectPatchOperationInterface.html | 4 +- .../Reference.SystemStatusInterface.html | 4 +- .../Reference.ThemeExportInterface.html | 4 +- .../Reference.TokenCacheInterface.html | 2 +- .../Reference.TreeDependencyMapInterface.html | 2 +- .../Reference.TreeExportOptions.html | 10 +- ...Reference.TreeExportResolverInterface.html | 2 +- .../Reference.TreeImportOptions.html | 8 +- .../Reference.UiConfigInterface.html | 4 +- docs/interfaces/Reference.Updates.html | 8 +- .../Reference.UserExportInterface.html | 4 +- .../Reference.UserGroupExportInterface.html | 4 +- .../Reference.VariablesExportInterface.html | 4 +- docs/modules.html | 2 +- docs/modules/Reference.html | 4 +- docs/types/Reference.AccessTokenMetaType.html | 2 +- .../Reference.AccessTokenResponseType.html | 4 +- docs/types/Reference.Admin.html | 28 ++-- docs/types/Reference.AdminFederation.html | 30 ++--- ...ference.AdminFederationConfigSkeleton.html | 2 +- docs/types/Reference.Agent.html | 120 +++++++++--------- docs/types/Reference.AgentSkeleton.html | 2 +- docs/types/Reference.AgentType.html | 2 +- docs/types/Reference.AmServiceSkeleton.html | 2 +- docs/types/Reference.Application.html | 38 +++--- .../Reference.ApplicationExportOptions.html | 8 +- .../Reference.ApplicationImportOptions.html | 6 +- docs/types/Reference.ApplicationSkeleton.html | 2 +- docs/types/Reference.Authenticate.html | 6 +- .../Reference.AuthenticationSettings.html | 10 +- ...erence.AuthenticationSettingsSkeleton.html | 2 +- docs/types/Reference.Base64.html | 4 +- docs/types/Reference.Callback.html | 4 +- docs/types/Reference.CallbackHandler.html | 2 +- .../types/Reference.CallbackKeyValuePair.html | 4 +- docs/types/Reference.CallbackType.html | 2 +- .../Reference.CircleOfTrustSkeleton.html | 2 +- docs/types/Reference.CirclesOfTrust.html | 30 ++--- docs/types/Reference.Config.html | 6 +- docs/types/Reference.ConnectionProfile.html | 26 ++-- docs/types/Reference.Connector.html | 28 ++-- docs/types/Reference.ConnectorSkeleton.html | 2 +- docs/types/Reference.Constants.html | 4 +- docs/types/Reference.DeleteJourneyStatus.html | 4 +- .../types/Reference.DeleteJourneysStatus.html | 2 +- docs/types/Reference.EmailTemplate.html | 28 ++-- .../Reference.EmailTemplateSkeleton.html | 2 +- docs/types/Reference.ExportImport.html | 14 +- docs/types/Reference.FRUtils.html | 14 +- docs/types/Reference.Feature.html | 6 +- docs/types/Reference.Frodo.html | 16 +-- docs/types/Reference.GatewayAgentType.html | 2 +- docs/types/Reference.IdmConfig.html | 44 +++---- docs/types/Reference.IdmConfigStub.html | 2 +- docs/types/Reference.IdmSystem.html | 28 ++-- docs/types/Reference.Idp.html | 42 +++--- docs/types/Reference.Info.html | 4 +- docs/types/Reference.JavaAgentType.html | 2 +- docs/types/Reference.Jose.html | 4 +- docs/types/Reference.Journey.html | 60 ++++----- .../Reference.JourneyClassificationType.html | 2 +- docs/types/Reference.Json.html | 14 +- docs/types/Reference.JwkRsa.html | 2 +- docs/types/Reference.JwkRsaPublic.html | 2 +- docs/types/Reference.Log.html | 26 ++-- docs/types/Reference.LogApiKey.html | 4 +- .../Reference.LogEventPayloadSkeleton.html | 2 +- docs/types/Reference.LogEventSkeleton.html | 2 +- docs/types/Reference.ManagedObject.html | 26 ++-- docs/types/Reference.Mapping.html | 32 ++--- docs/types/Reference.MappingPolicy.html | 4 +- docs/types/Reference.MappingProperty.html | 4 +- docs/types/Reference.MappingSkeleton.html | 2 +- docs/types/Reference.Node.html | 52 ++++---- .../Reference.NodeClassificationType.html | 2 +- docs/types/Reference.NodeSkeleton.html | 2 +- docs/types/Reference.OAuth2Client.html | 32 ++--- .../types/Reference.OAuth2ClientSkeleton.html | 2 +- docs/types/Reference.OAuth2Oidc.html | 4 +- docs/types/Reference.OAuth2Provider.html | 12 +- .../Reference.OAuth2ProviderSkeleton.html | 2 +- .../Reference.OAuth2TrustedJwtIssuer.html | 32 ++--- ...erence.OAuth2TrustedJwtIssuerSkeleton.html | 2 +- docs/types/Reference.ObjectPropertyFlag.html | 2 +- .../Reference.ObjectPropertyNativeType.html | 2 +- .../Reference.ObjectPropertySkeleton.html | 4 +- docs/types/Reference.ObjectPropertyType.html | 2 +- docs/types/Reference.ObjectTypeSkeleton.html | 4 +- docs/types/Reference.Organization.html | 8 +- docs/types/Reference.PagedResult.html | 4 +- docs/types/Reference.PlatformInfo.html | 2 +- docs/types/Reference.Policy.html | 36 +++--- docs/types/Reference.PolicyCondition.html | 2 +- docs/types/Reference.PolicyConditionType.html | 2 +- docs/types/Reference.PolicySet.html | 24 ++-- docs/types/Reference.PolicySetSkeleton.html | 2 +- docs/types/Reference.PolicySkeleton.html | 2 +- ...Reference.ProgressIndicatorStatusType.html | 2 +- .../Reference.ProgressIndicatorType.html | 2 +- docs/types/Reference.Readable.html | 2 +- docs/types/Reference.Realm.html | 30 ++--- docs/types/Reference.RealmSkeleton.html | 2 +- docs/types/Reference.Recon.html | 12 +- docs/types/Reference.ReconStatusType.html | 2 +- docs/types/Reference.ReconType.html | 2 +- docs/types/Reference.ResourceType.html | 36 +++--- .../types/Reference.ResourceTypeSkeleton.html | 2 +- docs/types/Reference.Saml2.html | 38 +++--- .../types/Reference.Saml2ProiderLocation.html | 2 +- .../Reference.Saml2ProviderSkeleton.html | 2 +- docs/types/Reference.Saml2ProviderStub.html | 2 +- docs/types/Reference.Script.html | 38 +++--- docs/types/Reference.ScriptContext.html | 2 +- docs/types/Reference.ScriptLanguage.html | 2 +- docs/types/Reference.ScriptSkeleton.html | 2 +- docs/types/Reference.ScriptValidation.html | 4 +- docs/types/Reference.Secret.html | 52 ++++---- docs/types/Reference.SecretEncodingType.html | 4 +- docs/types/Reference.SecretSkeleton.html | 4 +- docs/types/Reference.Service.html | 20 +-- docs/types/Reference.ServiceAccount.html | 8 +- docs/types/Reference.ServiceAccountType.html | 2 +- docs/types/Reference.Session.html | 4 +- docs/types/Reference.SessionInfoType.html | 4 +- docs/types/Reference.SocialIdpSkeleton.html | 2 +- docs/types/Reference.Startup.html | 6 +- docs/types/Reference.State.html | 20 +-- docs/types/Reference.Theme.html | 40 +++--- docs/types/Reference.ThemeSkeleton.html | 2 +- docs/types/Reference.TokenCache.html | 32 ++--- .../Reference.TokenInfoResponseType.html | 4 +- docs/types/Reference.Tokens.html | 4 +- docs/types/Reference.TreeSkeleton.html | 2 +- docs/types/Reference.UserSessionMetaType.html | 2 +- docs/types/Reference.Variable.html | 32 ++--- .../Reference.VariableExpressionType.html | 4 +- docs/types/Reference.VariableSkeleton.html | 4 +- docs/types/Reference.Version.html | 4 +- .../Reference.VersionOfSecretSkeleton.html | 4 +- .../Reference.VersionOfSecretStatus.html | 2 +- docs/types/Reference.WebAgentType.html | 2 +- docs/types/Reference.Writable.html | 4 +- docs/types/Reference.tokenType.html | 2 +- docs/variables/frodo.html | 4 +- docs/variables/state.html | 4 +- package-lock.json | 4 +- package.json | 2 +- 234 files changed, 1023 insertions(+), 1020 deletions(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index 94bd36319..be694dd28 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -7,6 +7,8 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0 ## [Unreleased] +## [4.0.0-11] - 2026-02-24 + ## [4.0.0-10] - 2026-02-19 ## [4.0.0-9] - 2026-02-19 @@ -2006,7 +2008,8 @@ Frodo supports exporting and importing of ESV secret values. To leave stuartship - Fixed problem with adding connection profiles - Miscellaneous bug fixes -[unreleased]: https://github.com/rockcarver/frodo-lib/compare/v4.0.0-10...HEAD +[unreleased]: https://github.com/rockcarver/frodo-lib/compare/v4.0.0-11...HEAD +[4.0.0-11]: https://github.com/rockcarver/frodo-lib/compare/v4.0.0-10...v4.0.0-11 [4.0.0-10]: https://github.com/rockcarver/frodo-lib/compare/v4.0.0-9...v4.0.0-10 [4.0.0-9]: https://github.com/rockcarver/frodo-lib/compare/v4.0.0-8...v4.0.0-9 [4.0.0-8]: https://github.com/rockcarver/frodo-lib/compare/v4.0.0-7...v4.0.0-8 diff --git a/docs/classes/FrodoError.html b/docs/classes/FrodoError.html index a54e68704..c099d6408 100644 --- a/docs/classes/FrodoError.html +++ b/docs/classes/FrodoError.html @@ -1,4 +1,4 @@ -FrodoError | Frodo Library - v4.0.0-10
Frodo Library - v4.0.0-10
    Preparing search index...

    Class FrodoError

    Hierarchy

    • Error
      • FrodoError
    Index

    Constructors

    constructor +FrodoError | Frodo Library - v4.0.0-11
    Frodo Library - v4.0.0-11
      Preparing search index...

      Class FrodoError

      Hierarchy

      • Error
        • FrodoError
      Index

      Constructors

      • Parameters

        • message: string
        • originalErrors: Error | Error[] = null

        Returns FrodoError

      Properties

      httpCode: string
      httpDescription: string
      httpDetail: string
      httpErrorReason: string
      httpErrorText: string
      httpMessage: string
      httpStatus: number
      isHttpError: boolean = false
      originalErrors: Error[] = []

      Methods

      • Parameters

        • level: number = 1

        Returns string

      • Returns a string representation of an object.

        -

        Returns string

      +

      Constructors

      • Parameters

        • message: string
        • originalErrors: Error | Error[] = null

        Returns FrodoError

      Properties

      httpCode: string
      httpDescription: string
      httpDetail: string
      httpErrorReason: string
      httpErrorText: string
      httpMessage: string
      httpStatus: number
      isHttpError: boolean = false
      originalErrors: Error[] = []

      Methods

      • Parameters

        • level: number = 1

        Returns string

      • Returns a string representation of an object.

        +

        Returns string

      diff --git a/docs/enums/Reference.EnforcementGroup.html b/docs/enums/Reference.EnforcementGroup.html index efaf858e1..b3c08cfac 100644 --- a/docs/enums/Reference.EnforcementGroup.html +++ b/docs/enums/Reference.EnforcementGroup.html @@ -1,4 +1,4 @@ -EnforcementGroup | Frodo Library - v4.0.0-10
      Frodo Library - v4.0.0-10
        Preparing search index...

        Enumeration EnforcementGroup

        Index

        Enumeration Members

        AllAdmins +EnforcementGroup | Frodo Library - v4.0.0-11
        Frodo Library - v4.0.0-11
          Preparing search index...

          Enumeration EnforcementGroup

          Index

          Enumeration Members

          Enumeration Members

          AllAdmins: "all"
          Nobody: "none"
          TenantAdmins: "non-global"
          +

          Enumeration Members

          AllAdmins: "all"
          Nobody: "none"
          TenantAdmins: "non-global"
          diff --git a/docs/hierarchy.html b/docs/hierarchy.html index ed1ac9af6..b4f00614b 100644 --- a/docs/hierarchy.html +++ b/docs/hierarchy.html @@ -1 +1 @@ -Frodo Library - v4.0.0-10
          Frodo Library - v4.0.0-10
            Preparing search index...
            +Frodo Library - v4.0.0-11
            Frodo Library - v4.0.0-11
              Preparing search index...
              diff --git a/docs/index.html b/docs/index.html index 208a9f794..4995928b7 100644 --- a/docs/index.html +++ b/docs/index.html @@ -1,4 +1,4 @@ -Frodo Library - v4.0.0-10
              Frodo Library - v4.0.0-10
                Preparing search index...

                Frodo Library - v4.0.0-10

                +Frodo Library - v4.0.0-11
                Frodo Library - v4.0.0-11
                  Preparing search index...

                  Frodo Library - v4.0.0-11

                  Frodo Library 4.x - @rockcarver/frodo-lib

                  A hybrid (ESM and CJS) library to manage PingOne Advanced Identity Cloud environments, ForgeOps deployments, and classic deployments.

                  Frodo-lib powers frodo-cli, the command line tool to manage SaaS and self-hosted deployments.

                  @@ -490,4 +490,4 @@

                  If you are a maintainer of this repository, please refer to the pipeline and release process instructions.

                  -
                  +
                  diff --git a/docs/interfaces/Reference.AdminFederationExportInterface.html b/docs/interfaces/Reference.AdminFederationExportInterface.html index d807a2667..5dcd1b7ac 100644 --- a/docs/interfaces/Reference.AdminFederationExportInterface.html +++ b/docs/interfaces/Reference.AdminFederationExportInterface.html @@ -1,4 +1,4 @@ -AdminFederationExportInterface | Frodo Library - v4.0.0-10
                  Frodo Library - v4.0.0-10
                    Preparing search index...

                    Interface AdminFederationExportInterface

                    interface AdminFederationExportInterface {
                        config: Record<string, AdminFederationConfigSkeleton>;
                        idp: Record<string, SocialIdpSkeleton>;
                        meta?: ExportMetaData;
                    }
                    Index

                    Properties

                    config +AdminFederationExportInterface | Frodo Library - v4.0.0-11
                    Frodo Library - v4.0.0-11
                      Preparing search index...

                      Interface AdminFederationExportInterface

                      interface AdminFederationExportInterface {
                          config: Record<string, AdminFederationConfigSkeleton>;
                          idp: Record<string, SocialIdpSkeleton>;
                          meta?: ExportMetaData;
                      }
                      Index

                      Properties

                      Properties

                      config: Record<string, AdminFederationConfigSkeleton>
                      idp: Record<string, SocialIdpSkeleton>
                      +

                      Properties

                      config: Record<string, AdminFederationConfigSkeleton>
                      idp: Record<string, SocialIdpSkeleton>
                      diff --git a/docs/interfaces/Reference.AgentExportInterface.html b/docs/interfaces/Reference.AgentExportInterface.html index e51e2e757..8b7685f63 100644 --- a/docs/interfaces/Reference.AgentExportInterface.html +++ b/docs/interfaces/Reference.AgentExportInterface.html @@ -1,3 +1,3 @@ -AgentExportInterface | Frodo Library - v4.0.0-10
                      Frodo Library - v4.0.0-10
                        Preparing search index...

                        Interface AgentExportInterface

                        interface AgentExportInterface {
                            agent: Record<string, AgentSkeleton>;
                            meta?: ExportMetaData;
                        }
                        Index

                        Properties

                        agent +AgentExportInterface | Frodo Library - v4.0.0-11
                        Frodo Library - v4.0.0-11
                          Preparing search index...

                          Interface AgentExportInterface

                          interface AgentExportInterface {
                              agent: Record<string, AgentSkeleton>;
                              meta?: ExportMetaData;
                          }
                          Index

                          Properties

                          Properties

                          agent: Record<string, AgentSkeleton>
                          +

                          Properties

                          agent: Record<string, AgentSkeleton>
                          diff --git a/docs/interfaces/Reference.AgentGroupExportInterface.html b/docs/interfaces/Reference.AgentGroupExportInterface.html index 6ddd99da1..ae1004502 100644 --- a/docs/interfaces/Reference.AgentGroupExportInterface.html +++ b/docs/interfaces/Reference.AgentGroupExportInterface.html @@ -1,3 +1,3 @@ -AgentGroupExportInterface | Frodo Library - v4.0.0-10
                          Frodo Library - v4.0.0-10
                            Preparing search index...

                            Interface AgentGroupExportInterface

                            interface AgentGroupExportInterface {
                                agentGroup: Record<string, AgentGroupSkeleton>;
                                meta?: ExportMetaData;
                            }
                            Index

                            Properties

                            agentGroup +AgentGroupExportInterface | Frodo Library - v4.0.0-11
                            Frodo Library - v4.0.0-11
                              Preparing search index...

                              Interface AgentGroupExportInterface

                              interface AgentGroupExportInterface {
                                  agentGroup: Record<string, AgentGroupSkeleton>;
                                  meta?: ExportMetaData;
                              }
                              Index

                              Properties

                              Properties

                              agentGroup: Record<string, AgentGroupSkeleton>
                              +

                              Properties

                              agentGroup: Record<string, AgentGroupSkeleton>
                              diff --git a/docs/interfaces/Reference.AmConfigEntitiesInterface.html b/docs/interfaces/Reference.AmConfigEntitiesInterface.html index fbcdf8a08..9c014db70 100644 --- a/docs/interfaces/Reference.AmConfigEntitiesInterface.html +++ b/docs/interfaces/Reference.AmConfigEntitiesInterface.html @@ -1,4 +1,4 @@ -AmConfigEntitiesInterface | Frodo Library - v4.0.0-10
                              Frodo Library - v4.0.0-10
                                Preparing search index...

                                Interface AmConfigEntitiesInterface

                                Hierarchy (View Summary)

                                Index

                                Properties

                                applicationTypes +AmConfigEntitiesInterface | Frodo Library - v4.0.0-11
                                Frodo Library - v4.0.0-11
                                  Preparing search index...

                                  Interface AmConfigEntitiesInterface

                                  Hierarchy (View Summary)

                                  Index

                                  Properties

                                  applicationTypes: AmConfigEntityInterface
                                  authenticationChains: AmConfigEntityInterface
                                  authenticationModules: AmConfigEntityInterface
                                  authenticationTreesConfiguration: AmConfigEntityInterface
                                  conditionTypes: AmConfigEntityInterface
                                  decisionCombiners: AmConfigEntityInterface
                                  serverInformation: AmConfigEntityInterface
                                  subjectAttributes: AmConfigEntityInterface
                                  webhookService: AmConfigEntityInterface
                                  +

                                  Properties

                                  applicationTypes: AmConfigEntityInterface
                                  authenticationChains: AmConfigEntityInterface
                                  authenticationModules: AmConfigEntityInterface
                                  authenticationTreesConfiguration: AmConfigEntityInterface
                                  conditionTypes: AmConfigEntityInterface
                                  decisionCombiners: AmConfigEntityInterface
                                  serverInformation: AmConfigEntityInterface
                                  subjectAttributes: AmConfigEntityInterface
                                  webhookService: AmConfigEntityInterface
                                  diff --git a/docs/interfaces/Reference.AmConfigEntityInterface.html b/docs/interfaces/Reference.AmConfigEntityInterface.html index 50fee9b51..1c477c918 100644 --- a/docs/interfaces/Reference.AmConfigEntityInterface.html +++ b/docs/interfaces/Reference.AmConfigEntityInterface.html @@ -1,4 +1,4 @@ -AmConfigEntityInterface | Frodo Library - v4.0.0-10
                                  Frodo Library - v4.0.0-10
                                    Preparing search index...

                                    Interface AmConfigEntityInterface

                                    interface AmConfigEntityInterface {
                                        _id?: string;
                                        _rev?: string;
                                        _type?: EntityType;
                                        [k: string]:
                                            | string
                                            | number
                                            | boolean
                                            | object
                                            | string[]
                                            | IdObjectSkeletonInterface;
                                    }

                                    Hierarchy (View Summary)

                                    Indexable

                                    Index

                                    Properties

                                    _id? +AmConfigEntityInterface | Frodo Library - v4.0.0-11
                                    Frodo Library - v4.0.0-11
                                      Preparing search index...

                                      Interface AmConfigEntityInterface

                                      interface AmConfigEntityInterface {
                                          _id?: string;
                                          _rev?: string;
                                          _type?: EntityType;
                                          [k: string]:
                                              | string
                                              | number
                                              | boolean
                                              | object
                                              | string[]
                                              | IdObjectSkeletonInterface;
                                      }

                                      Hierarchy (View Summary)

                                      Indexable

                                      Index

                                      Properties

                                      Properties

                                      _id?: string
                                      _rev?: string
                                      _type?: EntityType
                                      +

                                      Properties

                                      _id?: string
                                      _rev?: string
                                      _type?: EntityType
                                      diff --git a/docs/interfaces/Reference.ApplicationExportInterface.html b/docs/interfaces/Reference.ApplicationExportInterface.html index abe608475..c5258ea93 100644 --- a/docs/interfaces/Reference.ApplicationExportInterface.html +++ b/docs/interfaces/Reference.ApplicationExportInterface.html @@ -1,5 +1,5 @@ -ApplicationExportInterface | Frodo Library - v4.0.0-10
                                      Frodo Library - v4.0.0-10
                                        Preparing search index...

                                        Interface ApplicationExportInterface

                                        Export format for applications

                                        -
                                        interface ApplicationExportInterface {
                                            application?: Record<string, OAuth2ClientSkeleton>;
                                            connector?: Record<string, ConnectorSkeleton>;
                                            managedApplication: Record<string, ApplicationSkeleton>;
                                            mapping?: Record<string, MappingSkeleton>;
                                            meta?: ExportMetaData;
                                            saml?: {
                                                cot?: Record<string, CircleOfTrustSkeleton>;
                                                hosted?: Record<string, Saml2ProviderSkeleton>;
                                                metadata?: Record<string, string[]>;
                                                remote?: Record<string, Saml2ProviderSkeleton>;
                                            };
                                            script?: Record<string, ScriptSkeleton>;
                                        }
                                        Index

                                        Properties

                                        application? +ApplicationExportInterface | Frodo Library - v4.0.0-11
                                        Frodo Library - v4.0.0-11
                                          Preparing search index...

                                          Interface ApplicationExportInterface

                                          Export format for applications

                                          +
                                          interface ApplicationExportInterface {
                                              application?: Record<string, OAuth2ClientSkeleton>;
                                              connector?: Record<string, ConnectorSkeleton>;
                                              managedApplication: Record<string, ApplicationSkeleton>;
                                              mapping?: Record<string, MappingSkeleton>;
                                              meta?: ExportMetaData;
                                              saml?: {
                                                  cot?: Record<string, CircleOfTrustSkeleton>;
                                                  hosted?: Record<string, Saml2ProviderSkeleton>;
                                                  metadata?: Record<string, string[]>;
                                                  remote?: Record<string, Saml2ProviderSkeleton>;
                                              };
                                              script?: Record<string, ScriptSkeleton>;
                                          }
                                          Index

                                          Properties

                                          application?: Record<string, OAuth2ClientSkeleton>

                                          OAuth2 clients

                                          -
                                          connector?: Record<string, ConnectorSkeleton>

                                          connectors

                                          -
                                          managedApplication: Record<string, ApplicationSkeleton>

                                          Managed applications

                                          -
                                          mapping?: Record<string, MappingSkeleton>

                                          mappings

                                          -

                                          Metadata

                                          -
                                          saml?: {
                                              cot?: Record<string, CircleOfTrustSkeleton>;
                                              hosted?: Record<string, Saml2ProviderSkeleton>;
                                              metadata?: Record<string, string[]>;
                                              remote?: Record<string, Saml2ProviderSkeleton>;
                                          }

                                          Saml providers, circles of trust, and metadata

                                          -
                                          script?: Record<string, ScriptSkeleton>

                                          Scripts

                                          -
                                          +
                                          connector?: Record<string, ConnectorSkeleton>

                                          connectors

                                          +
                                          managedApplication: Record<string, ApplicationSkeleton>

                                          Managed applications

                                          +
                                          mapping?: Record<string, MappingSkeleton>

                                          mappings

                                          +

                                          Metadata

                                          +
                                          saml?: {
                                              cot?: Record<string, CircleOfTrustSkeleton>;
                                              hosted?: Record<string, Saml2ProviderSkeleton>;
                                              metadata?: Record<string, string[]>;
                                              remote?: Record<string, Saml2ProviderSkeleton>;
                                          }

                                          Saml providers, circles of trust, and metadata

                                          +
                                          script?: Record<string, ScriptSkeleton>

                                          Scripts

                                          +
                                          diff --git a/docs/interfaces/Reference.AuthenticationSettingsExportInterface.html b/docs/interfaces/Reference.AuthenticationSettingsExportInterface.html index 778c40893..75d60f8c5 100644 --- a/docs/interfaces/Reference.AuthenticationSettingsExportInterface.html +++ b/docs/interfaces/Reference.AuthenticationSettingsExportInterface.html @@ -1,3 +1,3 @@ -AuthenticationSettingsExportInterface | Frodo Library - v4.0.0-10
                                          Frodo Library - v4.0.0-10
                                            Preparing search index...

                                            Interface AuthenticationSettingsExportInterface

                                            interface AuthenticationSettingsExportInterface {
                                                authentication: AuthenticationSettingsSkeleton;
                                                meta?: ExportMetaData;
                                            }
                                            Index

                                            Properties

                                            authentication +AuthenticationSettingsExportInterface | Frodo Library - v4.0.0-11
                                            Frodo Library - v4.0.0-11
                                              Preparing search index...

                                              Interface AuthenticationSettingsExportInterface

                                              interface AuthenticationSettingsExportInterface {
                                                  authentication: AuthenticationSettingsSkeleton;
                                                  meta?: ExportMetaData;
                                              }
                                              Index

                                              Properties

                                              Properties

                                              +

                                              Properties

                                              diff --git a/docs/interfaces/Reference.CirclesOfTrustExportInterface.html b/docs/interfaces/Reference.CirclesOfTrustExportInterface.html index d2c1773d1..8e45c94cc 100644 --- a/docs/interfaces/Reference.CirclesOfTrustExportInterface.html +++ b/docs/interfaces/Reference.CirclesOfTrustExportInterface.html @@ -1,4 +1,4 @@ -CirclesOfTrustExportInterface | Frodo Library - v4.0.0-10
                                              Frodo Library - v4.0.0-10
                                                Preparing search index...

                                                Interface CirclesOfTrustExportInterface

                                                interface CirclesOfTrustExportInterface {
                                                    meta?: ExportMetaData;
                                                    saml: {
                                                        cot: Record<string, CircleOfTrustSkeleton>;
                                                        hosted: Record<string, Saml2ProviderSkeleton>;
                                                        metadata: Record<string, string[]>;
                                                        remote: Record<string, Saml2ProviderSkeleton>;
                                                    };
                                                    script: Record<string, ScriptSkeleton>;
                                                }
                                                Index

                                                Properties

                                                meta? +CirclesOfTrustExportInterface | Frodo Library - v4.0.0-11
                                                Frodo Library - v4.0.0-11
                                                  Preparing search index...

                                                  Interface CirclesOfTrustExportInterface

                                                  interface CirclesOfTrustExportInterface {
                                                      meta?: ExportMetaData;
                                                      saml: {
                                                          cot: Record<string, CircleOfTrustSkeleton>;
                                                          hosted: Record<string, Saml2ProviderSkeleton>;
                                                          metadata: Record<string, string[]>;
                                                          remote: Record<string, Saml2ProviderSkeleton>;
                                                      };
                                                      script: Record<string, ScriptSkeleton>;
                                                  }
                                                  Index

                                                  Properties

                                                  Properties

                                                  saml: {
                                                      cot: Record<string, CircleOfTrustSkeleton>;
                                                      hosted: Record<string, Saml2ProviderSkeleton>;
                                                      metadata: Record<string, string[]>;
                                                      remote: Record<string, Saml2ProviderSkeleton>;
                                                  }
                                                  script: Record<string, ScriptSkeleton>
                                                  +

                                                  Properties

                                                  saml: {
                                                      cot: Record<string, CircleOfTrustSkeleton>;
                                                      hosted: Record<string, Saml2ProviderSkeleton>;
                                                      metadata: Record<string, string[]>;
                                                      remote: Record<string, Saml2ProviderSkeleton>;
                                                  }
                                                  script: Record<string, ScriptSkeleton>
                                                  diff --git a/docs/interfaces/Reference.ConfigEntityExportInterface-1.html b/docs/interfaces/Reference.ConfigEntityExportInterface-1.html index d27378918..fb45d875f 100644 --- a/docs/interfaces/Reference.ConfigEntityExportInterface-1.html +++ b/docs/interfaces/Reference.ConfigEntityExportInterface-1.html @@ -1,3 +1,3 @@ -ConfigEntityExportInterface | Frodo Library - v4.0.0-10
                                                  Frodo Library - v4.0.0-10
                                                    Preparing search index...

                                                    Interface ConfigEntityExportInterface

                                                    interface ConfigEntityExportInterface {
                                                        idm: Record<string, IdObjectSkeletonInterface>;
                                                        meta?: ExportMetaData;
                                                    }
                                                    Index

                                                    Properties

                                                    idm +ConfigEntityExportInterface | Frodo Library - v4.0.0-11
                                                    Frodo Library - v4.0.0-11
                                                      Preparing search index...

                                                      Interface ConfigEntityExportInterface

                                                      interface ConfigEntityExportInterface {
                                                          idm: Record<string, IdObjectSkeletonInterface>;
                                                          meta?: ExportMetaData;
                                                      }
                                                      Index

                                                      Properties

                                                      Properties

                                                      idm: Record<string, IdObjectSkeletonInterface>
                                                      +

                                                      Properties

                                                      idm: Record<string, IdObjectSkeletonInterface>
                                                      diff --git a/docs/interfaces/Reference.ConfigEntityExportInterface.html b/docs/interfaces/Reference.ConfigEntityExportInterface.html index 4edefafc6..e08cc5ce0 100644 --- a/docs/interfaces/Reference.ConfigEntityExportInterface.html +++ b/docs/interfaces/Reference.ConfigEntityExportInterface.html @@ -1,4 +1,4 @@ -ConfigEntityExportInterface | Frodo Library - v4.0.0-10
                                                      Frodo Library - v4.0.0-10
                                                        Preparing search index...

                                                        Interface ConfigEntityExportInterface

                                                        interface ConfigEntityExportInterface {
                                                            global: Record<string, Record<string, AmConfigEntityInterface>>;
                                                            meta?: ExportMetaData;
                                                            realm: Record<
                                                                string,
                                                                Record<string, Record<string, AmConfigEntityInterface>>,
                                                            >;
                                                        }
                                                        Index

                                                        Properties

                                                        global +ConfigEntityExportInterface | Frodo Library - v4.0.0-11
                                                        Frodo Library - v4.0.0-11
                                                          Preparing search index...

                                                          Interface ConfigEntityExportInterface

                                                          interface ConfigEntityExportInterface {
                                                              global: Record<string, Record<string, AmConfigEntityInterface>>;
                                                              meta?: ExportMetaData;
                                                              realm: Record<
                                                                  string,
                                                                  Record<string, Record<string, AmConfigEntityInterface>>,
                                                              >;
                                                          }
                                                          Index

                                                          Properties

                                                          Properties

                                                          global: Record<string, Record<string, AmConfigEntityInterface>>
                                                          realm: Record<string, Record<string, Record<string, AmConfigEntityInterface>>>
                                                          +

                                                          Properties

                                                          global: Record<string, Record<string, AmConfigEntityInterface>>
                                                          realm: Record<string, Record<string, Record<string, AmConfigEntityInterface>>>
                                                          diff --git a/docs/interfaces/Reference.ConfigEntityExportOptions.html b/docs/interfaces/Reference.ConfigEntityExportOptions.html index bc427e173..3f565a056 100644 --- a/docs/interfaces/Reference.ConfigEntityExportOptions.html +++ b/docs/interfaces/Reference.ConfigEntityExportOptions.html @@ -1,6 +1,6 @@ -ConfigEntityExportOptions | Frodo Library - v4.0.0-10
                                                          Frodo Library - v4.0.0-10
                                                            Preparing search index...

                                                            Interface ConfigEntityExportOptions

                                                            Idm export options

                                                            -
                                                            interface ConfigEntityExportOptions {
                                                                entitiesToExport?: string[];
                                                                envReplaceParams?: string[][];
                                                            }
                                                            Index

                                                            Properties

                                                            entitiesToExport? +ConfigEntityExportOptions | Frodo Library - v4.0.0-11
                                                            Frodo Library - v4.0.0-11
                                                              Preparing search index...

                                                              Interface ConfigEntityExportOptions

                                                              Idm export options

                                                              +
                                                              interface ConfigEntityExportOptions {
                                                                  entitiesToExport?: string[];
                                                                  envReplaceParams?: string[][];
                                                              }
                                                              Index

                                                              Properties

                                                              entitiesToExport?: string[]

                                                              Gives a list of entities to export. If undefined or empty, it will export all entities.

                                                              -
                                                              envReplaceParams?: string[][]

                                                              Gives the list of key-value pairs of env replacements. Replaces each occurrence of the value with '${key}', where key is the correspond key to the value.

                                                              -
                                                              +
                                                              envReplaceParams?: string[][]

                                                              Gives the list of key-value pairs of env replacements. Replaces each occurrence of the value with '${key}', where key is the correspond key to the value.

                                                              +
                                                              diff --git a/docs/interfaces/Reference.ConfigEntityImportOptions.html b/docs/interfaces/Reference.ConfigEntityImportOptions.html index 95a7a614a..9d59ab8a6 100644 --- a/docs/interfaces/Reference.ConfigEntityImportOptions.html +++ b/docs/interfaces/Reference.ConfigEntityImportOptions.html @@ -1,8 +1,8 @@ -ConfigEntityImportOptions | Frodo Library - v4.0.0-10
                                                              Frodo Library - v4.0.0-10
                                                                Preparing search index...

                                                                Interface ConfigEntityImportOptions

                                                                Config entity import options

                                                                -
                                                                interface ConfigEntityImportOptions {
                                                                    entitiesToImport?: string[];
                                                                    envReplaceParams?: string[][];
                                                                    validate: boolean;
                                                                }
                                                                Index

                                                                Properties

                                                                entitiesToImport? +ConfigEntityImportOptions | Frodo Library - v4.0.0-11
                                                                Frodo Library - v4.0.0-11
                                                                  Preparing search index...

                                                                  Interface ConfigEntityImportOptions

                                                                  Config entity import options

                                                                  +
                                                                  interface ConfigEntityImportOptions {
                                                                      entitiesToImport?: string[];
                                                                      envReplaceParams?: string[][];
                                                                      validate: boolean;
                                                                  }
                                                                  Index

                                                                  Properties

                                                                  entitiesToImport?: string[]

                                                                  Gives a list of entities to import. If undefined or empty, it will import all entities.

                                                                  -
                                                                  envReplaceParams?: string[][]

                                                                  Gives the list of key-value pairs of env replacements. Replaces each occurrence of '${key}' with its value.

                                                                  -
                                                                  validate: boolean

                                                                  validate script hooks

                                                                  -
                                                                  +
                                                                  envReplaceParams?: string[][]

                                                                  Gives the list of key-value pairs of env replacements. Replaces each occurrence of '${key}' with its value.

                                                                  +
                                                                  validate: boolean

                                                                  validate script hooks

                                                                  +
                                                                  diff --git a/docs/interfaces/Reference.ConnectionProfileInterface.html b/docs/interfaces/Reference.ConnectionProfileInterface.html index 38d596edd..6a5ae20ba 100644 --- a/docs/interfaces/Reference.ConnectionProfileInterface.html +++ b/docs/interfaces/Reference.ConnectionProfileInterface.html @@ -1,4 +1,4 @@ -ConnectionProfileInterface | Frodo Library - v4.0.0-10
                                                                  Frodo Library - v4.0.0-10
                                                                    Preparing search index...

                                                                    Interface ConnectionProfileInterface

                                                                    interface ConnectionProfileInterface {
                                                                        adminClientId?: string;
                                                                        adminClientRedirectUri?: string;
                                                                        alias?: string;
                                                                        allowInsecureConnection?: boolean;
                                                                        amsterPrivateKey?: string;
                                                                        authenticationHeaderOverrides?: Record<string, string>;
                                                                        authenticationService?: string;
                                                                        deploymentType?: string;
                                                                        idmHost?: string;
                                                                        isIGA?: boolean;
                                                                        logApiKey?: string;
                                                                        logApiSecret?: string;
                                                                        password?: string;
                                                                        svcacctId?: string;
                                                                        svcacctJwk?: JwkRsa;
                                                                        svcacctName?: string;
                                                                        svcacctScope?: string;
                                                                        tenant: string;
                                                                        username?: string;
                                                                    }
                                                                    Index

                                                                    Properties

                                                                    adminClientId? +ConnectionProfileInterface | Frodo Library - v4.0.0-11
                                                                    Frodo Library - v4.0.0-11
                                                                      Preparing search index...

                                                                      Interface ConnectionProfileInterface

                                                                      interface ConnectionProfileInterface {
                                                                          adminClientId?: string;
                                                                          adminClientRedirectUri?: string;
                                                                          alias?: string;
                                                                          allowInsecureConnection?: boolean;
                                                                          amsterPrivateKey?: string;
                                                                          authenticationHeaderOverrides?: Record<string, string>;
                                                                          authenticationService?: string;
                                                                          deploymentType?: string;
                                                                          idmHost?: string;
                                                                          isIGA?: boolean;
                                                                          logApiKey?: string;
                                                                          logApiSecret?: string;
                                                                          password?: string;
                                                                          svcacctId?: string;
                                                                          svcacctJwk?: JwkRsa;
                                                                          svcacctName?: string;
                                                                          svcacctScope?: string;
                                                                          tenant: string;
                                                                          username?: string;
                                                                      }
                                                                      Index

                                                                      Properties

                                                                      adminClientId?: string
                                                                      adminClientRedirectUri?: string
                                                                      alias?: string
                                                                      allowInsecureConnection?: boolean
                                                                      amsterPrivateKey?: string
                                                                      authenticationHeaderOverrides?: Record<string, string>
                                                                      authenticationService?: string
                                                                      deploymentType?: string
                                                                      idmHost?: string
                                                                      isIGA?: boolean
                                                                      logApiKey?: string
                                                                      logApiSecret?: string
                                                                      password?: string
                                                                      svcacctId?: string
                                                                      svcacctJwk?: JwkRsa
                                                                      svcacctName?: string
                                                                      svcacctScope?: string
                                                                      tenant: string
                                                                      username?: string
                                                                      +

                                                                      Properties

                                                                      adminClientId?: string
                                                                      adminClientRedirectUri?: string
                                                                      alias?: string
                                                                      allowInsecureConnection?: boolean
                                                                      amsterPrivateKey?: string
                                                                      authenticationHeaderOverrides?: Record<string, string>
                                                                      authenticationService?: string
                                                                      deploymentType?: string
                                                                      idmHost?: string
                                                                      isIGA?: boolean
                                                                      logApiKey?: string
                                                                      logApiSecret?: string
                                                                      password?: string
                                                                      svcacctId?: string
                                                                      svcacctJwk?: JwkRsa
                                                                      svcacctName?: string
                                                                      svcacctScope?: string
                                                                      tenant: string
                                                                      username?: string
                                                                      diff --git a/docs/interfaces/Reference.ConnectionsFileInterface.html b/docs/interfaces/Reference.ConnectionsFileInterface.html index fda2d4ace..644c89d10 100644 --- a/docs/interfaces/Reference.ConnectionsFileInterface.html +++ b/docs/interfaces/Reference.ConnectionsFileInterface.html @@ -1 +1 @@ -ConnectionsFileInterface | Frodo Library - v4.0.0-10
                                                                      Frodo Library - v4.0.0-10
                                                                        Preparing search index...

                                                                        Interface ConnectionsFileInterface

                                                                        Indexable

                                                                        +ConnectionsFileInterface | Frodo Library - v4.0.0-11
                                                                        Frodo Library - v4.0.0-11
                                                                          Preparing search index...

                                                                          Interface ConnectionsFileInterface

                                                                          Indexable

                                                                          diff --git a/docs/interfaces/Reference.ConnectorExportInterface.html b/docs/interfaces/Reference.ConnectorExportInterface.html index 45b5e3610..0498f0a42 100644 --- a/docs/interfaces/Reference.ConnectorExportInterface.html +++ b/docs/interfaces/Reference.ConnectorExportInterface.html @@ -1,4 +1,4 @@ -ConnectorExportInterface | Frodo Library - v4.0.0-10
                                                                          Frodo Library - v4.0.0-10
                                                                            Preparing search index...

                                                                            Interface ConnectorExportInterface

                                                                            interface ConnectorExportInterface {
                                                                                connector: Record<string, ConnectorSkeleton>;
                                                                                mapping?: Record<string, MappingSkeleton>;
                                                                                meta?: ExportMetaData;
                                                                            }
                                                                            Index

                                                                            Properties

                                                                            connector +ConnectorExportInterface | Frodo Library - v4.0.0-11
                                                                            Frodo Library - v4.0.0-11
                                                                              Preparing search index...

                                                                              Interface ConnectorExportInterface

                                                                              interface ConnectorExportInterface {
                                                                                  connector: Record<string, ConnectorSkeleton>;
                                                                                  mapping?: Record<string, MappingSkeleton>;
                                                                                  meta?: ExportMetaData;
                                                                              }
                                                                              Index

                                                                              Properties

                                                                              connector: Record<string, ConnectorSkeleton>
                                                                              mapping?: Record<string, MappingSkeleton>
                                                                              +

                                                                              Properties

                                                                              connector: Record<string, ConnectorSkeleton>
                                                                              mapping?: Record<string, MappingSkeleton>
                                                                              diff --git a/docs/interfaces/Reference.ConnectorExportOptions.html b/docs/interfaces/Reference.ConnectorExportOptions.html index 69a4a5c8c..641d0fddd 100644 --- a/docs/interfaces/Reference.ConnectorExportOptions.html +++ b/docs/interfaces/Reference.ConnectorExportOptions.html @@ -1,6 +1,6 @@ -ConnectorExportOptions | Frodo Library - v4.0.0-10
                                                                              Frodo Library - v4.0.0-10
                                                                                Preparing search index...

                                                                                Interface ConnectorExportOptions

                                                                                Connector export options

                                                                                -
                                                                                interface ConnectorExportOptions {
                                                                                    deps: boolean;
                                                                                    useStringArrays: boolean;
                                                                                }
                                                                                Index

                                                                                Properties

                                                                                deps +ConnectorExportOptions | Frodo Library - v4.0.0-11
                                                                                Frodo Library - v4.0.0-11
                                                                                  Preparing search index...

                                                                                  Interface ConnectorExportOptions

                                                                                  Connector export options

                                                                                  +
                                                                                  interface ConnectorExportOptions {
                                                                                      deps: boolean;
                                                                                      useStringArrays: boolean;
                                                                                  }
                                                                                  Index

                                                                                  Properties

                                                                                  deps: boolean

                                                                                  Include any dependencies (mappings).

                                                                                  -
                                                                                  useStringArrays: boolean

                                                                                  Use string arrays to store multi-line text in scripts.

                                                                                  -
                                                                                  +
                                                                                  useStringArrays: boolean

                                                                                  Use string arrays to store multi-line text in scripts.

                                                                                  +
                                                                                  diff --git a/docs/interfaces/Reference.ConnectorImportOptions.html b/docs/interfaces/Reference.ConnectorImportOptions.html index b4396cac6..a1ab93f39 100644 --- a/docs/interfaces/Reference.ConnectorImportOptions.html +++ b/docs/interfaces/Reference.ConnectorImportOptions.html @@ -1,4 +1,4 @@ -ConnectorImportOptions | Frodo Library - v4.0.0-10
                                                                                  Frodo Library - v4.0.0-10
                                                                                    Preparing search index...

                                                                                    Interface ConnectorImportOptions

                                                                                    Connector import options

                                                                                    -
                                                                                    interface ConnectorImportOptions {
                                                                                        deps: boolean;
                                                                                    }
                                                                                    Index

                                                                                    Properties

                                                                                    deps +ConnectorImportOptions | Frodo Library - v4.0.0-11
                                                                                    Frodo Library - v4.0.0-11
                                                                                      Preparing search index...

                                                                                      Interface ConnectorImportOptions

                                                                                      Connector import options

                                                                                      +
                                                                                      interface ConnectorImportOptions {
                                                                                          deps: boolean;
                                                                                      }
                                                                                      Index

                                                                                      Properties

                                                                                      Properties

                                                                                      deps: boolean

                                                                                      Include any dependencies (mappings).

                                                                                      -
                                                                                      +
                                                                                      diff --git a/docs/interfaces/Reference.ConnectorServerStatusInterface.html b/docs/interfaces/Reference.ConnectorServerStatusInterface.html index bb163d444..951be3591 100644 --- a/docs/interfaces/Reference.ConnectorServerStatusInterface.html +++ b/docs/interfaces/Reference.ConnectorServerStatusInterface.html @@ -1,4 +1,4 @@ -ConnectorServerStatusInterface | Frodo Library - v4.0.0-10
                                                                                      Frodo Library - v4.0.0-10
                                                                                        Preparing search index...

                                                                                        Interface ConnectorServerStatusInterface

                                                                                        interface ConnectorServerStatusInterface {
                                                                                            name: string;
                                                                                            ok: boolean;
                                                                                            type: string;
                                                                                        }
                                                                                        Index

                                                                                        Properties

                                                                                        name +ConnectorServerStatusInterface | Frodo Library - v4.0.0-11
                                                                                        Frodo Library - v4.0.0-11
                                                                                          Preparing search index...

                                                                                          Interface ConnectorServerStatusInterface

                                                                                          interface ConnectorServerStatusInterface {
                                                                                              name: string;
                                                                                              ok: boolean;
                                                                                              type: string;
                                                                                          }
                                                                                          Index

                                                                                          Properties

                                                                                          Properties

                                                                                          name: string
                                                                                          ok: boolean
                                                                                          type: string
                                                                                          +

                                                                                          Properties

                                                                                          name: string
                                                                                          ok: boolean
                                                                                          type: string
                                                                                          diff --git a/docs/interfaces/Reference.CustomNodeExportInterface.html b/docs/interfaces/Reference.CustomNodeExportInterface.html index 46619d15a..15cb5ead7 100644 --- a/docs/interfaces/Reference.CustomNodeExportInterface.html +++ b/docs/interfaces/Reference.CustomNodeExportInterface.html @@ -1,3 +1,3 @@ -CustomNodeExportInterface | Frodo Library - v4.0.0-10
                                                                                          Frodo Library - v4.0.0-10
                                                                                            Preparing search index...

                                                                                            Interface CustomNodeExportInterface

                                                                                            interface CustomNodeExportInterface {
                                                                                                meta?: ExportMetaData;
                                                                                                nodeTypes: Record<string, CustomNodeSkeleton>;
                                                                                            }
                                                                                            Index

                                                                                            Properties

                                                                                            meta? +CustomNodeExportInterface | Frodo Library - v4.0.0-11
                                                                                            Frodo Library - v4.0.0-11
                                                                                              Preparing search index...

                                                                                              Interface CustomNodeExportInterface

                                                                                              interface CustomNodeExportInterface {
                                                                                                  meta?: ExportMetaData;
                                                                                                  nodeTypes: Record<string, CustomNodeSkeleton>;
                                                                                              }
                                                                                              Index

                                                                                              Properties

                                                                                              Properties

                                                                                              nodeTypes: Record<string, CustomNodeSkeleton>
                                                                                              +

                                                                                              Properties

                                                                                              nodeTypes: Record<string, CustomNodeSkeleton>
                                                                                              diff --git a/docs/interfaces/Reference.CustomNodeExportOptions.html b/docs/interfaces/Reference.CustomNodeExportOptions.html index 9e90d54e3..2b26c285c 100644 --- a/docs/interfaces/Reference.CustomNodeExportOptions.html +++ b/docs/interfaces/Reference.CustomNodeExportOptions.html @@ -1,4 +1,4 @@ -CustomNodeExportOptions | Frodo Library - v4.0.0-10
                                                                                              Frodo Library - v4.0.0-10
                                                                                                Preparing search index...

                                                                                                Interface CustomNodeExportOptions

                                                                                                Custom node export options

                                                                                                -
                                                                                                interface CustomNodeExportOptions {
                                                                                                    useStringArrays: boolean;
                                                                                                }
                                                                                                Index

                                                                                                Properties

                                                                                                useStringArrays +CustomNodeExportOptions | Frodo Library - v4.0.0-11
                                                                                                Frodo Library - v4.0.0-11
                                                                                                  Preparing search index...

                                                                                                  Interface CustomNodeExportOptions

                                                                                                  Custom node export options

                                                                                                  +
                                                                                                  interface CustomNodeExportOptions {
                                                                                                      useStringArrays: boolean;
                                                                                                  }
                                                                                                  Index

                                                                                                  Properties

                                                                                                  Properties

                                                                                                  useStringArrays: boolean

                                                                                                  Use string arrays to store script code

                                                                                                  -
                                                                                                  +
                                                                                                  diff --git a/docs/interfaces/Reference.CustomNodeImportOptions.html b/docs/interfaces/Reference.CustomNodeImportOptions.html index af47c44e2..33d02841e 100644 --- a/docs/interfaces/Reference.CustomNodeImportOptions.html +++ b/docs/interfaces/Reference.CustomNodeImportOptions.html @@ -1,6 +1,6 @@ -CustomNodeImportOptions | Frodo Library - v4.0.0-10
                                                                                                  Frodo Library - v4.0.0-10
                                                                                                    Preparing search index...

                                                                                                    Interface CustomNodeImportOptions

                                                                                                    Custom node import options

                                                                                                    -
                                                                                                    interface CustomNodeImportOptions {
                                                                                                        reUuid: boolean;
                                                                                                        wait: boolean;
                                                                                                    }
                                                                                                    Index

                                                                                                    Properties

                                                                                                    reUuid +CustomNodeImportOptions | Frodo Library - v4.0.0-11
                                                                                                    Frodo Library - v4.0.0-11
                                                                                                      Preparing search index...

                                                                                                      Interface CustomNodeImportOptions

                                                                                                      Custom node import options

                                                                                                      +
                                                                                                      interface CustomNodeImportOptions {
                                                                                                          reUuid: boolean;
                                                                                                          wait: boolean;
                                                                                                      }
                                                                                                      Index

                                                                                                      Properties

                                                                                                      Properties

                                                                                                      reUuid: boolean

                                                                                                      Generate new UUIDs and service names for all custom nodes during import.

                                                                                                      -
                                                                                                      wait: boolean

                                                                                                      Wait for AM to load new custom nodes before returning.

                                                                                                      -
                                                                                                      +
                                                                                                      wait: boolean

                                                                                                      Wait for AM to load new custom nodes before returning.

                                                                                                      +
                                                                                                      diff --git a/docs/interfaces/Reference.EmailTemplateExportInterface.html b/docs/interfaces/Reference.EmailTemplateExportInterface.html index ac26b3ee0..40a630409 100644 --- a/docs/interfaces/Reference.EmailTemplateExportInterface.html +++ b/docs/interfaces/Reference.EmailTemplateExportInterface.html @@ -1,3 +1,3 @@ -EmailTemplateExportInterface | Frodo Library - v4.0.0-10
                                                                                                      Frodo Library - v4.0.0-10
                                                                                                        Preparing search index...

                                                                                                        Interface EmailTemplateExportInterface

                                                                                                        interface EmailTemplateExportInterface {
                                                                                                            emailTemplate: Record<string, EmailTemplateSkeleton>;
                                                                                                            meta?: ExportMetaData;
                                                                                                        }
                                                                                                        Index

                                                                                                        Properties

                                                                                                        emailTemplate +EmailTemplateExportInterface | Frodo Library - v4.0.0-11
                                                                                                        Frodo Library - v4.0.0-11
                                                                                                          Preparing search index...

                                                                                                          Interface EmailTemplateExportInterface

                                                                                                          interface EmailTemplateExportInterface {
                                                                                                              emailTemplate: Record<string, EmailTemplateSkeleton>;
                                                                                                              meta?: ExportMetaData;
                                                                                                          }
                                                                                                          Index

                                                                                                          Properties

                                                                                                          Properties

                                                                                                          emailTemplate: Record<string, EmailTemplateSkeleton>
                                                                                                          +

                                                                                                          Properties

                                                                                                          emailTemplate: Record<string, EmailTemplateSkeleton>
                                                                                                          diff --git a/docs/interfaces/Reference.EnvInfoInterface.html b/docs/interfaces/Reference.EnvInfoInterface.html index 9a5dbe092..37e2d2b05 100644 --- a/docs/interfaces/Reference.EnvInfoInterface.html +++ b/docs/interfaces/Reference.EnvInfoInterface.html @@ -1,4 +1,4 @@ -EnvInfoInterface | Frodo Library - v4.0.0-10
                                                                                                          Frodo Library - v4.0.0-10
                                                                                                            Preparing search index...

                                                                                                            Interface EnvInfoInterface

                                                                                                            interface EnvInfoInterface {
                                                                                                                config_promotion_done: boolean;
                                                                                                                immutable: boolean;
                                                                                                                locked: boolean;
                                                                                                                message_box_html: string;
                                                                                                                message_box_title: string;
                                                                                                                message_variant: string;
                                                                                                                placeholder_management: "CUSTOMER" | "SRE";
                                                                                                                placeholder_management_migration_date: string;
                                                                                                                region: string;
                                                                                                                tier: string;
                                                                                                                warning_message_html: string;
                                                                                                            }
                                                                                                            Index

                                                                                                            Properties

                                                                                                            config_promotion_done +EnvInfoInterface | Frodo Library - v4.0.0-11
                                                                                                            Frodo Library - v4.0.0-11
                                                                                                              Preparing search index...

                                                                                                              Interface EnvInfoInterface

                                                                                                              interface EnvInfoInterface {
                                                                                                                  config_promotion_done: boolean;
                                                                                                                  immutable: boolean;
                                                                                                                  locked: boolean;
                                                                                                                  message_box_html: string;
                                                                                                                  message_box_title: string;
                                                                                                                  message_variant: string;
                                                                                                                  placeholder_management: "CUSTOMER" | "SRE";
                                                                                                                  placeholder_management_migration_date: string;
                                                                                                                  region: string;
                                                                                                                  tier: string;
                                                                                                                  warning_message_html: string;
                                                                                                              }
                                                                                                              Index

                                                                                                              Properties

                                                                                                              config_promotion_done: boolean
                                                                                                              immutable: boolean
                                                                                                              locked: boolean
                                                                                                              message_box_html: string
                                                                                                              message_box_title: string
                                                                                                              message_variant: string
                                                                                                              placeholder_management: "CUSTOMER" | "SRE"
                                                                                                              placeholder_management_migration_date: string
                                                                                                              region: string
                                                                                                              tier: string
                                                                                                              warning_message_html: string
                                                                                                              +

                                                                                                              Properties

                                                                                                              config_promotion_done: boolean
                                                                                                              immutable: boolean
                                                                                                              locked: boolean
                                                                                                              message_box_html: string
                                                                                                              message_box_title: string
                                                                                                              message_variant: string
                                                                                                              placeholder_management: "CUSTOMER" | "SRE"
                                                                                                              placeholder_management_migration_date: string
                                                                                                              region: string
                                                                                                              tier: string
                                                                                                              warning_message_html: string
                                                                                                              diff --git a/docs/interfaces/Reference.ExportMetaData.html b/docs/interfaces/Reference.ExportMetaData.html index bcb04867f..43e4dbbf5 100644 --- a/docs/interfaces/Reference.ExportMetaData.html +++ b/docs/interfaces/Reference.ExportMetaData.html @@ -1,7 +1,7 @@ -ExportMetaData | Frodo Library - v4.0.0-10
                                                                                                              Frodo Library - v4.0.0-10
                                                                                                                Preparing search index...

                                                                                                                Interface ExportMetaData

                                                                                                                interface ExportMetaData {
                                                                                                                    exportDate: string;
                                                                                                                    exportedBy: string;
                                                                                                                    exportTool: string;
                                                                                                                    exportToolVersion: string;
                                                                                                                    origin: string;
                                                                                                                    originAmVersion: string;
                                                                                                                }
                                                                                                                Index

                                                                                                                Properties

                                                                                                                exportDate +ExportMetaData | Frodo Library - v4.0.0-11
                                                                                                                Frodo Library - v4.0.0-11
                                                                                                                  Preparing search index...

                                                                                                                  Interface ExportMetaData

                                                                                                                  interface ExportMetaData {
                                                                                                                      exportDate: string;
                                                                                                                      exportedBy: string;
                                                                                                                      exportTool: string;
                                                                                                                      exportToolVersion: string;
                                                                                                                      origin: string;
                                                                                                                      originAmVersion: string;
                                                                                                                  }
                                                                                                                  Index

                                                                                                                  Properties

                                                                                                                  exportDate: string
                                                                                                                  exportedBy: string
                                                                                                                  exportTool: string
                                                                                                                  exportToolVersion: string
                                                                                                                  origin: string
                                                                                                                  originAmVersion: string
                                                                                                                  +

                                                                                                                  Properties

                                                                                                                  exportDate: string
                                                                                                                  exportedBy: string
                                                                                                                  exportTool: string
                                                                                                                  exportToolVersion: string
                                                                                                                  origin: string
                                                                                                                  originAmVersion: string
                                                                                                                  diff --git a/docs/interfaces/Reference.FeatureInterface.html b/docs/interfaces/Reference.FeatureInterface.html index ef7eadc81..7e04f263a 100644 --- a/docs/interfaces/Reference.FeatureInterface.html +++ b/docs/interfaces/Reference.FeatureInterface.html @@ -1,5 +1,5 @@ -FeatureInterface | Frodo Library - v4.0.0-10
                                                                                                                  Frodo Library - v4.0.0-10
                                                                                                                    Preparing search index...

                                                                                                                    Interface FeatureInterface

                                                                                                                    interface FeatureInterface {
                                                                                                                        _id?: string;
                                                                                                                        _rev?: string;
                                                                                                                        availableVersions: string[];
                                                                                                                        installedVersion: string;
                                                                                                                        [k: string]:
                                                                                                                            | string
                                                                                                                            | number
                                                                                                                            | boolean
                                                                                                                            | object
                                                                                                                            | string[]
                                                                                                                            | IdObjectSkeletonInterface;
                                                                                                                    }

                                                                                                                    Hierarchy (View Summary)

                                                                                                                    Indexable

                                                                                                                    Index

                                                                                                                    Properties

                                                                                                                    _id? +FeatureInterface | Frodo Library - v4.0.0-11
                                                                                                                    Frodo Library - v4.0.0-11
                                                                                                                      Preparing search index...

                                                                                                                      Interface FeatureInterface

                                                                                                                      interface FeatureInterface {
                                                                                                                          _id?: string;
                                                                                                                          _rev?: string;
                                                                                                                          availableVersions: string[];
                                                                                                                          installedVersion: string;
                                                                                                                          [k: string]:
                                                                                                                              | string
                                                                                                                              | number
                                                                                                                              | boolean
                                                                                                                              | object
                                                                                                                              | string[]
                                                                                                                              | IdObjectSkeletonInterface;
                                                                                                                      }

                                                                                                                      Hierarchy (View Summary)

                                                                                                                      Indexable

                                                                                                                      Index

                                                                                                                      Properties

                                                                                                                      _id?: string
                                                                                                                      _rev?: string
                                                                                                                      availableVersions: string[]
                                                                                                                      installedVersion: string
                                                                                                                      +

                                                                                                                      Properties

                                                                                                                      _id?: string
                                                                                                                      _rev?: string
                                                                                                                      availableVersions: string[]
                                                                                                                      installedVersion: string
                                                                                                                      diff --git a/docs/interfaces/Reference.FullExportInterface.html b/docs/interfaces/Reference.FullExportInterface.html index b3a6b12bb..afc55b3e8 100644 --- a/docs/interfaces/Reference.FullExportInterface.html +++ b/docs/interfaces/Reference.FullExportInterface.html @@ -1,4 +1,4 @@ -FullExportInterface | Frodo Library - v4.0.0-10
                                                                                                                      Frodo Library - v4.0.0-10
                                                                                                                        Preparing search index...

                                                                                                                        Interface FullExportInterface

                                                                                                                        interface FullExportInterface {
                                                                                                                            global: FullGlobalExportInterface;
                                                                                                                            meta?: ExportMetaData;
                                                                                                                            realm: Record<string, FullRealmExportInterface>;
                                                                                                                        }
                                                                                                                        Index

                                                                                                                        Properties

                                                                                                                        global +FullExportInterface | Frodo Library - v4.0.0-11
                                                                                                                        Frodo Library - v4.0.0-11
                                                                                                                          Preparing search index...

                                                                                                                          Interface FullExportInterface

                                                                                                                          interface FullExportInterface {
                                                                                                                              global: FullGlobalExportInterface;
                                                                                                                              meta?: ExportMetaData;
                                                                                                                              realm: Record<string, FullRealmExportInterface>;
                                                                                                                          }
                                                                                                                          Index

                                                                                                                          Properties

                                                                                                                          Properties

                                                                                                                          realm: Record<string, FullRealmExportInterface>
                                                                                                                          +

                                                                                                                          Properties

                                                                                                                          realm: Record<string, FullRealmExportInterface>
                                                                                                                          diff --git a/docs/interfaces/Reference.FullExportOptions.html b/docs/interfaces/Reference.FullExportOptions.html index 7dc51ac50..1918f473b 100644 --- a/docs/interfaces/Reference.FullExportOptions.html +++ b/docs/interfaces/Reference.FullExportOptions.html @@ -1,5 +1,5 @@ -FullExportOptions | Frodo Library - v4.0.0-10
                                                                                                                          Frodo Library - v4.0.0-10
                                                                                                                            Preparing search index...

                                                                                                                            Interface FullExportOptions

                                                                                                                            Full export options

                                                                                                                            -
                                                                                                                            interface FullExportOptions {
                                                                                                                                coords: boolean;
                                                                                                                                includeActiveValues: boolean;
                                                                                                                                includeDefault: boolean;
                                                                                                                                includeReadOnly: boolean;
                                                                                                                                noDecode: boolean;
                                                                                                                                onlyGlobal: boolean;
                                                                                                                                onlyRealm: boolean;
                                                                                                                                target?: string;
                                                                                                                                useStringArrays: boolean;
                                                                                                                            }
                                                                                                                            Index

                                                                                                                            Properties

                                                                                                                            coords +FullExportOptions | Frodo Library - v4.0.0-11
                                                                                                                            Frodo Library - v4.0.0-11
                                                                                                                              Preparing search index...

                                                                                                                              Interface FullExportOptions

                                                                                                                              Full export options

                                                                                                                              +
                                                                                                                              interface FullExportOptions {
                                                                                                                                  coords: boolean;
                                                                                                                                  includeActiveValues: boolean;
                                                                                                                                  includeDefault: boolean;
                                                                                                                                  includeReadOnly: boolean;
                                                                                                                                  noDecode: boolean;
                                                                                                                                  onlyGlobal: boolean;
                                                                                                                                  onlyRealm: boolean;
                                                                                                                                  target?: string;
                                                                                                                                  useStringArrays: boolean;
                                                                                                                              }
                                                                                                                              Index

                                                                                                                              Properties

                                                                                                                              coords: boolean

                                                                                                                              Include x and y coordinate positions of the journey/tree nodes.

                                                                                                                              -
                                                                                                                              includeActiveValues: boolean

                                                                                                                              Include active and loaded secret values

                                                                                                                              -
                                                                                                                              includeDefault: boolean

                                                                                                                              Include default scripts in export if true

                                                                                                                              -
                                                                                                                              includeReadOnly: boolean

                                                                                                                              Include read only config in export if true

                                                                                                                              -
                                                                                                                              noDecode: boolean

                                                                                                                              Do not include decoded variable value in export

                                                                                                                              -
                                                                                                                              onlyGlobal: boolean

                                                                                                                              Export only global config

                                                                                                                              -
                                                                                                                              onlyRealm: boolean

                                                                                                                              Export config only for the current realm

                                                                                                                              -
                                                                                                                              target?: string

                                                                                                                              Host URL of target environment to encrypt secret values for

                                                                                                                              -
                                                                                                                              useStringArrays: boolean

                                                                                                                              Use string arrays to store multi-line text in scripts.

                                                                                                                              -
                                                                                                                              +
                                                                                                                              includeActiveValues: boolean

                                                                                                                              Include active and loaded secret values

                                                                                                                              +
                                                                                                                              includeDefault: boolean

                                                                                                                              Include default scripts in export if true

                                                                                                                              +
                                                                                                                              includeReadOnly: boolean

                                                                                                                              Include read only config in export if true

                                                                                                                              +
                                                                                                                              noDecode: boolean

                                                                                                                              Do not include decoded variable value in export

                                                                                                                              +
                                                                                                                              onlyGlobal: boolean

                                                                                                                              Export only global config

                                                                                                                              +
                                                                                                                              onlyRealm: boolean

                                                                                                                              Export config only for the current realm

                                                                                                                              +
                                                                                                                              target?: string

                                                                                                                              Host URL of target environment to encrypt secret values for

                                                                                                                              +
                                                                                                                              useStringArrays: boolean

                                                                                                                              Use string arrays to store multi-line text in scripts.

                                                                                                                              +
                                                                                                                              diff --git a/docs/interfaces/Reference.FullGlobalExportInterface.html b/docs/interfaces/Reference.FullGlobalExportInterface.html index 0ee097a6c..1cc96961b 100644 --- a/docs/interfaces/Reference.FullGlobalExportInterface.html +++ b/docs/interfaces/Reference.FullGlobalExportInterface.html @@ -1,4 +1,4 @@ -FullGlobalExportInterface | Frodo Library - v4.0.0-10
                                                                                                                              Frodo Library - v4.0.0-10
                                                                                                                                Preparing search index...

                                                                                                                                Interface FullGlobalExportInterface

                                                                                                                                interface FullGlobalExportInterface {
                                                                                                                                    agent: Record<string, AmConfigEntityInterface>;
                                                                                                                                    applicationTypes: AmConfigEntityInterface;
                                                                                                                                    authentication: AuthenticationSettingsSkeleton;
                                                                                                                                    authenticationChains: AmConfigEntityInterface;
                                                                                                                                    authenticationModules: AmConfigEntityInterface;
                                                                                                                                    authenticationTreesConfiguration: AmConfigEntityInterface;
                                                                                                                                    conditionTypes: AmConfigEntityInterface;
                                                                                                                                    decisionCombiners: AmConfigEntityInterface;
                                                                                                                                    emailTemplate: Record<string, EmailTemplateSkeleton>;
                                                                                                                                    idm: Record<string, IdObjectSkeletonInterface>;
                                                                                                                                    internalRole: Record<string, InternalRoleSkeleton>;
                                                                                                                                    mapping: Record<string, MappingSkeleton>;
                                                                                                                                    nodeTypes: Record<string, CustomNodeSkeleton>;
                                                                                                                                    realm: Record<string, RealmSkeleton>;
                                                                                                                                    scripttype: Record<string, ScriptTypeExportSkeleton>;
                                                                                                                                    secret: Record<string, SecretSkeleton>;
                                                                                                                                    secrets: AmConfigEntityInterface;
                                                                                                                                    secretstore: Record<string, SecretStoreExportSkeleton>;
                                                                                                                                    server: ServerExportInterface;
                                                                                                                                    serverInformation: AmConfigEntityInterface;
                                                                                                                                    serverVersion: AmConfigEntityInterface;
                                                                                                                                    service: Record<string, AmServiceSkeleton>;
                                                                                                                                    site: Record<string, SiteSkeleton>;
                                                                                                                                    subjectAttributes: AmConfigEntityInterface;
                                                                                                                                    subjectTypes: AmConfigEntityInterface;
                                                                                                                                    sync: SyncSkeleton;
                                                                                                                                    variable: Record<string, VariableSkeleton>;
                                                                                                                                    webhookService: AmConfigEntityInterface;
                                                                                                                                    wsEntity: AmConfigEntityInterface;
                                                                                                                                }

                                                                                                                                Hierarchy (View Summary)

                                                                                                                                Index

                                                                                                                                Properties

                                                                                                                                agent +FullGlobalExportInterface | Frodo Library - v4.0.0-11
                                                                                                                                Frodo Library - v4.0.0-11
                                                                                                                                  Preparing search index...

                                                                                                                                  Interface FullGlobalExportInterface

                                                                                                                                  interface FullGlobalExportInterface {
                                                                                                                                      agent: Record<string, AmConfigEntityInterface>;
                                                                                                                                      applicationTypes: AmConfigEntityInterface;
                                                                                                                                      authentication: AuthenticationSettingsSkeleton;
                                                                                                                                      authenticationChains: AmConfigEntityInterface;
                                                                                                                                      authenticationModules: AmConfigEntityInterface;
                                                                                                                                      authenticationTreesConfiguration: AmConfigEntityInterface;
                                                                                                                                      conditionTypes: AmConfigEntityInterface;
                                                                                                                                      decisionCombiners: AmConfigEntityInterface;
                                                                                                                                      emailTemplate: Record<string, EmailTemplateSkeleton>;
                                                                                                                                      idm: Record<string, IdObjectSkeletonInterface>;
                                                                                                                                      internalRole: Record<string, InternalRoleSkeleton>;
                                                                                                                                      mapping: Record<string, MappingSkeleton>;
                                                                                                                                      nodeTypes: Record<string, CustomNodeSkeleton>;
                                                                                                                                      realm: Record<string, RealmSkeleton>;
                                                                                                                                      scripttype: Record<string, ScriptTypeExportSkeleton>;
                                                                                                                                      secret: Record<string, SecretSkeleton>;
                                                                                                                                      secrets: AmConfigEntityInterface;
                                                                                                                                      secretstore: Record<string, SecretStoreExportSkeleton>;
                                                                                                                                      server: ServerExportInterface;
                                                                                                                                      serverInformation: AmConfigEntityInterface;
                                                                                                                                      serverVersion: AmConfigEntityInterface;
                                                                                                                                      service: Record<string, AmServiceSkeleton>;
                                                                                                                                      site: Record<string, SiteSkeleton>;
                                                                                                                                      subjectAttributes: AmConfigEntityInterface;
                                                                                                                                      subjectTypes: AmConfigEntityInterface;
                                                                                                                                      sync: SyncSkeleton;
                                                                                                                                      variable: Record<string, VariableSkeleton>;
                                                                                                                                      webhookService: AmConfigEntityInterface;
                                                                                                                                      wsEntity: AmConfigEntityInterface;
                                                                                                                                  }

                                                                                                                                  Hierarchy (View Summary)

                                                                                                                                  Index

                                                                                                                                  Properties

                                                                                                                                  agent: Record<string, AmConfigEntityInterface>
                                                                                                                                  applicationTypes: AmConfigEntityInterface
                                                                                                                                  authenticationChains: AmConfigEntityInterface
                                                                                                                                  authenticationModules: AmConfigEntityInterface
                                                                                                                                  authenticationTreesConfiguration: AmConfigEntityInterface
                                                                                                                                  conditionTypes: AmConfigEntityInterface
                                                                                                                                  decisionCombiners: AmConfigEntityInterface
                                                                                                                                  emailTemplate: Record<string, EmailTemplateSkeleton>
                                                                                                                                  idm: Record<string, IdObjectSkeletonInterface>
                                                                                                                                  internalRole: Record<string, InternalRoleSkeleton>
                                                                                                                                  mapping: Record<string, MappingSkeleton>
                                                                                                                                  nodeTypes: Record<string, CustomNodeSkeleton>
                                                                                                                                  realm: Record<string, RealmSkeleton>
                                                                                                                                  scripttype: Record<string, ScriptTypeExportSkeleton>
                                                                                                                                  secret: Record<string, SecretSkeleton>
                                                                                                                                  secretstore: Record<string, SecretStoreExportSkeleton>
                                                                                                                                  serverInformation: AmConfigEntityInterface
                                                                                                                                  service: Record<string, AmServiceSkeleton>
                                                                                                                                  site: Record<string, SiteSkeleton>
                                                                                                                                  subjectAttributes: AmConfigEntityInterface
                                                                                                                                  variable: Record<string, VariableSkeleton>
                                                                                                                                  webhookService: AmConfigEntityInterface
                                                                                                                                  +

                                                                                                                                  Properties

                                                                                                                                  agent: Record<string, AmConfigEntityInterface>
                                                                                                                                  applicationTypes: AmConfigEntityInterface
                                                                                                                                  authenticationChains: AmConfigEntityInterface
                                                                                                                                  authenticationModules: AmConfigEntityInterface
                                                                                                                                  authenticationTreesConfiguration: AmConfigEntityInterface
                                                                                                                                  conditionTypes: AmConfigEntityInterface
                                                                                                                                  decisionCombiners: AmConfigEntityInterface
                                                                                                                                  emailTemplate: Record<string, EmailTemplateSkeleton>
                                                                                                                                  idm: Record<string, IdObjectSkeletonInterface>
                                                                                                                                  internalRole: Record<string, InternalRoleSkeleton>
                                                                                                                                  mapping: Record<string, MappingSkeleton>
                                                                                                                                  nodeTypes: Record<string, CustomNodeSkeleton>
                                                                                                                                  realm: Record<string, RealmSkeleton>
                                                                                                                                  scripttype: Record<string, ScriptTypeExportSkeleton>
                                                                                                                                  secret: Record<string, SecretSkeleton>
                                                                                                                                  secretstore: Record<string, SecretStoreExportSkeleton>
                                                                                                                                  serverInformation: AmConfigEntityInterface
                                                                                                                                  service: Record<string, AmServiceSkeleton>
                                                                                                                                  site: Record<string, SiteSkeleton>
                                                                                                                                  subjectAttributes: AmConfigEntityInterface
                                                                                                                                  variable: Record<string, VariableSkeleton>
                                                                                                                                  webhookService: AmConfigEntityInterface
                                                                                                                                  diff --git a/docs/interfaces/Reference.FullImportOptions.html b/docs/interfaces/Reference.FullImportOptions.html index 51095ddd0..0487edf56 100644 --- a/docs/interfaces/Reference.FullImportOptions.html +++ b/docs/interfaces/Reference.FullImportOptions.html @@ -1,5 +1,5 @@ -FullImportOptions | Frodo Library - v4.0.0-10
                                                                                                                                  Frodo Library - v4.0.0-10
                                                                                                                                    Preparing search index...

                                                                                                                                    Interface FullImportOptions

                                                                                                                                    Full import options

                                                                                                                                    -
                                                                                                                                    interface FullImportOptions {
                                                                                                                                        cleanServices: boolean;
                                                                                                                                        includeActiveValues: boolean;
                                                                                                                                        includeDefault: boolean;
                                                                                                                                        reUuidCustomNodes: boolean;
                                                                                                                                        reUuidJourneys: boolean;
                                                                                                                                        reUuidScripts: boolean;
                                                                                                                                        source?: string;
                                                                                                                                    }
                                                                                                                                    Index

                                                                                                                                    Properties

                                                                                                                                    cleanServices +FullImportOptions | Frodo Library - v4.0.0-11
                                                                                                                                    Frodo Library - v4.0.0-11
                                                                                                                                      Preparing search index...

                                                                                                                                      Interface FullImportOptions

                                                                                                                                      Full import options

                                                                                                                                      +
                                                                                                                                      interface FullImportOptions {
                                                                                                                                          cleanServices: boolean;
                                                                                                                                          includeActiveValues: boolean;
                                                                                                                                          includeDefault: boolean;
                                                                                                                                          reUuidCustomNodes: boolean;
                                                                                                                                          reUuidJourneys: boolean;
                                                                                                                                          reUuidScripts: boolean;
                                                                                                                                          source?: string;
                                                                                                                                      }
                                                                                                                                      Index

                                                                                                                                      Properties

                                                                                                                                      cleanServices: boolean

                                                                                                                                      Indicates whether to remove previously existing services of the same id before importing

                                                                                                                                      -
                                                                                                                                      includeActiveValues: boolean

                                                                                                                                      Include active secret values

                                                                                                                                      -
                                                                                                                                      includeDefault: boolean

                                                                                                                                      Include default scripts in import if true

                                                                                                                                      -
                                                                                                                                      reUuidCustomNodes: boolean

                                                                                                                                      Generate new UUIDs and service names for all custom nodes during import.

                                                                                                                                      -
                                                                                                                                      reUuidJourneys: boolean

                                                                                                                                      Generate new UUIDs for all journey nodes during import.

                                                                                                                                      -
                                                                                                                                      reUuidScripts: boolean

                                                                                                                                      Generate new UUIDs for all scripts during import.

                                                                                                                                      -
                                                                                                                                      source?: string

                                                                                                                                      Host URL of source environment to decrypt secret values from

                                                                                                                                      -
                                                                                                                                      +
                                                                                                                                      includeActiveValues: boolean

                                                                                                                                      Include active secret values

                                                                                                                                      +
                                                                                                                                      includeDefault: boolean

                                                                                                                                      Include default scripts in import if true

                                                                                                                                      +
                                                                                                                                      reUuidCustomNodes: boolean

                                                                                                                                      Generate new UUIDs and service names for all custom nodes during import.

                                                                                                                                      +
                                                                                                                                      reUuidJourneys: boolean

                                                                                                                                      Generate new UUIDs for all journey nodes during import.

                                                                                                                                      +
                                                                                                                                      reUuidScripts: boolean

                                                                                                                                      Generate new UUIDs for all scripts during import.

                                                                                                                                      +
                                                                                                                                      source?: string

                                                                                                                                      Host URL of source environment to decrypt secret values from

                                                                                                                                      +
                                                                                                                                      diff --git a/docs/interfaces/Reference.FullRealmExportInterface.html b/docs/interfaces/Reference.FullRealmExportInterface.html index be6f2e752..9bb9ade55 100644 --- a/docs/interfaces/Reference.FullRealmExportInterface.html +++ b/docs/interfaces/Reference.FullRealmExportInterface.html @@ -1,4 +1,4 @@ -FullRealmExportInterface | Frodo Library - v4.0.0-10
                                                                                                                                      Frodo Library - v4.0.0-10
                                                                                                                                        Preparing search index...

                                                                                                                                        Interface FullRealmExportInterface

                                                                                                                                        interface FullRealmExportInterface {
                                                                                                                                            agent: Record<string, AmConfigEntityInterface>;
                                                                                                                                            agentGroup: Record<string, AmConfigEntityInterface>;
                                                                                                                                            application: Record<string, OAuth2ClientSkeleton>;
                                                                                                                                            applicationTypes: AmConfigEntityInterface;
                                                                                                                                            authentication: AuthenticationSettingsSkeleton;
                                                                                                                                            authenticationChains: AmConfigEntityInterface;
                                                                                                                                            authenticationModules: AmConfigEntityInterface;
                                                                                                                                            authenticationTreesConfiguration: AmConfigEntityInterface;
                                                                                                                                            conditionTypes: AmConfigEntityInterface;
                                                                                                                                            decisionCombiners: AmConfigEntityInterface;
                                                                                                                                            idp: Record<string, SocialIdpSkeleton>;
                                                                                                                                            managedApplication: Record<string, ApplicationSkeleton>;
                                                                                                                                            policy: Record<string, PolicySkeleton>;
                                                                                                                                            policyset: Record<string, PolicySetSkeleton>;
                                                                                                                                            resourcetype: Record<string, ResourceTypeSkeleton>;
                                                                                                                                            saml: {
                                                                                                                                                cot: Record<string, CircleOfTrustSkeleton>;
                                                                                                                                                hosted: Record<string, Saml2ProviderSkeleton>;
                                                                                                                                                metadata: Record<string, string[]>;
                                                                                                                                                remote: Record<string, Saml2ProviderSkeleton>;
                                                                                                                                            };
                                                                                                                                            script: Record<string, ScriptSkeleton>;
                                                                                                                                            secrets: AmConfigEntityInterface;
                                                                                                                                            secretstore: Record<string, SecretStoreExportSkeleton>;
                                                                                                                                            serverInformation: AmConfigEntityInterface;
                                                                                                                                            serverVersion: AmConfigEntityInterface;
                                                                                                                                            service: Record<string, AmServiceSkeleton>;
                                                                                                                                            subjectAttributes: AmConfigEntityInterface;
                                                                                                                                            subjectTypes: AmConfigEntityInterface;
                                                                                                                                            theme: Record<string, ThemeSkeleton>;
                                                                                                                                            trees: Record<string, SingleTreeExportInterface>;
                                                                                                                                            trustedJwtIssuer: Record<string, OAuth2TrustedJwtIssuerSkeleton>;
                                                                                                                                            webhookService: AmConfigEntityInterface;
                                                                                                                                            wsEntity: AmConfigEntityInterface;
                                                                                                                                        }

                                                                                                                                        Hierarchy (View Summary)

                                                                                                                                        Index

                                                                                                                                        Properties

                                                                                                                                        agent +FullRealmExportInterface | Frodo Library - v4.0.0-11
                                                                                                                                        Frodo Library - v4.0.0-11
                                                                                                                                          Preparing search index...

                                                                                                                                          Interface FullRealmExportInterface

                                                                                                                                          interface FullRealmExportInterface {
                                                                                                                                              agent: Record<string, AmConfigEntityInterface>;
                                                                                                                                              agentGroup: Record<string, AmConfigEntityInterface>;
                                                                                                                                              application: Record<string, OAuth2ClientSkeleton>;
                                                                                                                                              applicationTypes: AmConfigEntityInterface;
                                                                                                                                              authentication: AuthenticationSettingsSkeleton;
                                                                                                                                              authenticationChains: AmConfigEntityInterface;
                                                                                                                                              authenticationModules: AmConfigEntityInterface;
                                                                                                                                              authenticationTreesConfiguration: AmConfigEntityInterface;
                                                                                                                                              conditionTypes: AmConfigEntityInterface;
                                                                                                                                              decisionCombiners: AmConfigEntityInterface;
                                                                                                                                              idp: Record<string, SocialIdpSkeleton>;
                                                                                                                                              managedApplication: Record<string, ApplicationSkeleton>;
                                                                                                                                              policy: Record<string, PolicySkeleton>;
                                                                                                                                              policyset: Record<string, PolicySetSkeleton>;
                                                                                                                                              resourcetype: Record<string, ResourceTypeSkeleton>;
                                                                                                                                              saml: {
                                                                                                                                                  cot: Record<string, CircleOfTrustSkeleton>;
                                                                                                                                                  hosted: Record<string, Saml2ProviderSkeleton>;
                                                                                                                                                  metadata: Record<string, string[]>;
                                                                                                                                                  remote: Record<string, Saml2ProviderSkeleton>;
                                                                                                                                              };
                                                                                                                                              script: Record<string, ScriptSkeleton>;
                                                                                                                                              secrets: AmConfigEntityInterface;
                                                                                                                                              secretstore: Record<string, SecretStoreExportSkeleton>;
                                                                                                                                              serverInformation: AmConfigEntityInterface;
                                                                                                                                              serverVersion: AmConfigEntityInterface;
                                                                                                                                              service: Record<string, AmServiceSkeleton>;
                                                                                                                                              subjectAttributes: AmConfigEntityInterface;
                                                                                                                                              subjectTypes: AmConfigEntityInterface;
                                                                                                                                              theme: Record<string, ThemeSkeleton>;
                                                                                                                                              trees: Record<string, SingleTreeExportInterface>;
                                                                                                                                              trustedJwtIssuer: Record<string, OAuth2TrustedJwtIssuerSkeleton>;
                                                                                                                                              webhookService: AmConfigEntityInterface;
                                                                                                                                              wsEntity: AmConfigEntityInterface;
                                                                                                                                          }

                                                                                                                                          Hierarchy (View Summary)

                                                                                                                                          Index

                                                                                                                                          Properties

                                                                                                                                          agent: Record<string, AmConfigEntityInterface>
                                                                                                                                          agentGroup: Record<string, AmConfigEntityInterface>
                                                                                                                                          application: Record<string, OAuth2ClientSkeleton>
                                                                                                                                          applicationTypes: AmConfigEntityInterface
                                                                                                                                          authenticationChains: AmConfigEntityInterface
                                                                                                                                          authenticationModules: AmConfigEntityInterface
                                                                                                                                          authenticationTreesConfiguration: AmConfigEntityInterface
                                                                                                                                          conditionTypes: AmConfigEntityInterface
                                                                                                                                          decisionCombiners: AmConfigEntityInterface
                                                                                                                                          idp: Record<string, SocialIdpSkeleton>
                                                                                                                                          managedApplication: Record<string, ApplicationSkeleton>
                                                                                                                                          policy: Record<string, PolicySkeleton>
                                                                                                                                          policyset: Record<string, PolicySetSkeleton>
                                                                                                                                          resourcetype: Record<string, ResourceTypeSkeleton>
                                                                                                                                          saml: {
                                                                                                                                              cot: Record<string, CircleOfTrustSkeleton>;
                                                                                                                                              hosted: Record<string, Saml2ProviderSkeleton>;
                                                                                                                                              metadata: Record<string, string[]>;
                                                                                                                                              remote: Record<string, Saml2ProviderSkeleton>;
                                                                                                                                          }
                                                                                                                                          script: Record<string, ScriptSkeleton>
                                                                                                                                          secretstore: Record<string, SecretStoreExportSkeleton>
                                                                                                                                          serverInformation: AmConfigEntityInterface
                                                                                                                                          service: Record<string, AmServiceSkeleton>
                                                                                                                                          subjectAttributes: AmConfigEntityInterface
                                                                                                                                          theme: Record<string, ThemeSkeleton>
                                                                                                                                          trees: Record<string, SingleTreeExportInterface>
                                                                                                                                          trustedJwtIssuer: Record<string, OAuth2TrustedJwtIssuerSkeleton>
                                                                                                                                          webhookService: AmConfigEntityInterface
                                                                                                                                          +

                                                                                                                                          Properties

                                                                                                                                          agent: Record<string, AmConfigEntityInterface>
                                                                                                                                          agentGroup: Record<string, AmConfigEntityInterface>
                                                                                                                                          application: Record<string, OAuth2ClientSkeleton>
                                                                                                                                          applicationTypes: AmConfigEntityInterface
                                                                                                                                          authenticationChains: AmConfigEntityInterface
                                                                                                                                          authenticationModules: AmConfigEntityInterface
                                                                                                                                          authenticationTreesConfiguration: AmConfigEntityInterface
                                                                                                                                          conditionTypes: AmConfigEntityInterface
                                                                                                                                          decisionCombiners: AmConfigEntityInterface
                                                                                                                                          idp: Record<string, SocialIdpSkeleton>
                                                                                                                                          managedApplication: Record<string, ApplicationSkeleton>
                                                                                                                                          policy: Record<string, PolicySkeleton>
                                                                                                                                          policyset: Record<string, PolicySetSkeleton>
                                                                                                                                          resourcetype: Record<string, ResourceTypeSkeleton>
                                                                                                                                          saml: {
                                                                                                                                              cot: Record<string, CircleOfTrustSkeleton>;
                                                                                                                                              hosted: Record<string, Saml2ProviderSkeleton>;
                                                                                                                                              metadata: Record<string, string[]>;
                                                                                                                                              remote: Record<string, Saml2ProviderSkeleton>;
                                                                                                                                          }
                                                                                                                                          script: Record<string, ScriptSkeleton>
                                                                                                                                          secretstore: Record<string, SecretStoreExportSkeleton>
                                                                                                                                          serverInformation: AmConfigEntityInterface
                                                                                                                                          service: Record<string, AmServiceSkeleton>
                                                                                                                                          subjectAttributes: AmConfigEntityInterface
                                                                                                                                          theme: Record<string, ThemeSkeleton>
                                                                                                                                          trees: Record<string, SingleTreeExportInterface>
                                                                                                                                          trustedJwtIssuer: Record<string, OAuth2TrustedJwtIssuerSkeleton>
                                                                                                                                          webhookService: AmConfigEntityInterface
                                                                                                                                          diff --git a/docs/interfaces/Reference.FullService.html b/docs/interfaces/Reference.FullService.html index 9d2ca9c55..fa5431691 100644 --- a/docs/interfaces/Reference.FullService.html +++ b/docs/interfaces/Reference.FullService.html @@ -1,5 +1,5 @@ -FullService | Frodo Library - v4.0.0-10
                                                                                                                                          Frodo Library - v4.0.0-10
                                                                                                                                            Preparing search index...

                                                                                                                                            Interface FullService

                                                                                                                                            interface FullService {
                                                                                                                                                _id?: string;
                                                                                                                                                _rev?: string;
                                                                                                                                                _type?: EntityType;
                                                                                                                                                nextDescendents?: ServiceNextDescendent[];
                                                                                                                                                [key: string]: any;
                                                                                                                                            }

                                                                                                                                            Hierarchy (View Summary)

                                                                                                                                            Indexable

                                                                                                                                            • [key: string]: any
                                                                                                                                            Index

                                                                                                                                            Properties

                                                                                                                                            _id? +FullService | Frodo Library - v4.0.0-11
                                                                                                                                            Frodo Library - v4.0.0-11
                                                                                                                                              Preparing search index...

                                                                                                                                              Interface FullService

                                                                                                                                              interface FullService {
                                                                                                                                                  _id?: string;
                                                                                                                                                  _rev?: string;
                                                                                                                                                  _type?: EntityType;
                                                                                                                                                  nextDescendents?: ServiceNextDescendent[];
                                                                                                                                                  [key: string]: any;
                                                                                                                                              }

                                                                                                                                              Hierarchy (View Summary)

                                                                                                                                              Indexable

                                                                                                                                              • [key: string]: any
                                                                                                                                              Index

                                                                                                                                              Properties

                                                                                                                                              _id?: string
                                                                                                                                              _rev?: string
                                                                                                                                              _type?: EntityType
                                                                                                                                              nextDescendents?: ServiceNextDescendent[]
                                                                                                                                              +

                                                                                                                                              Properties

                                                                                                                                              _id?: string
                                                                                                                                              _rev?: string
                                                                                                                                              _type?: EntityType
                                                                                                                                              nextDescendents?: ServiceNextDescendent[]
                                                                                                                                              diff --git a/docs/interfaces/Reference.IdObjectSkeletonInterface.html b/docs/interfaces/Reference.IdObjectSkeletonInterface.html index 7bd8d61e3..3ba29f0bc 100644 --- a/docs/interfaces/Reference.IdObjectSkeletonInterface.html +++ b/docs/interfaces/Reference.IdObjectSkeletonInterface.html @@ -1,3 +1,3 @@ -IdObjectSkeletonInterface | Frodo Library - v4.0.0-10
                                                                                                                                              Frodo Library - v4.0.0-10
                                                                                                                                                Preparing search index...

                                                                                                                                                Interface IdObjectSkeletonInterface

                                                                                                                                                interface IdObjectSkeletonInterface {
                                                                                                                                                    _id?: string;
                                                                                                                                                    _rev?: string;
                                                                                                                                                    [k: string]:
                                                                                                                                                        | string
                                                                                                                                                        | number
                                                                                                                                                        | boolean
                                                                                                                                                        | object
                                                                                                                                                        | string[]
                                                                                                                                                        | IdObjectSkeletonInterface;
                                                                                                                                                }

                                                                                                                                                Hierarchy (View Summary)

                                                                                                                                                Indexable

                                                                                                                                                Index

                                                                                                                                                Properties

                                                                                                                                                _id? +IdObjectSkeletonInterface | Frodo Library - v4.0.0-11
                                                                                                                                                Frodo Library - v4.0.0-11
                                                                                                                                                  Preparing search index...

                                                                                                                                                  Interface IdObjectSkeletonInterface

                                                                                                                                                  interface IdObjectSkeletonInterface {
                                                                                                                                                      _id?: string;
                                                                                                                                                      _rev?: string;
                                                                                                                                                      [k: string]:
                                                                                                                                                          | string
                                                                                                                                                          | number
                                                                                                                                                          | boolean
                                                                                                                                                          | object
                                                                                                                                                          | string[]
                                                                                                                                                          | IdObjectSkeletonInterface;
                                                                                                                                                  }

                                                                                                                                                  Hierarchy (View Summary)

                                                                                                                                                  Indexable

                                                                                                                                                  Index

                                                                                                                                                  Properties

                                                                                                                                                  Properties

                                                                                                                                                  _id?: string
                                                                                                                                                  _rev?: string
                                                                                                                                                  +

                                                                                                                                                  Properties

                                                                                                                                                  _id?: string
                                                                                                                                                  _rev?: string
                                                                                                                                                  diff --git a/docs/interfaces/Reference.InnerNodeRefSkeletonInterface.html b/docs/interfaces/Reference.InnerNodeRefSkeletonInterface.html index d0274a4aa..db8336632 100644 --- a/docs/interfaces/Reference.InnerNodeRefSkeletonInterface.html +++ b/docs/interfaces/Reference.InnerNodeRefSkeletonInterface.html @@ -1,4 +1,4 @@ -InnerNodeRefSkeletonInterface | Frodo Library - v4.0.0-10
                                                                                                                                                  Frodo Library - v4.0.0-10
                                                                                                                                                    Preparing search index...

                                                                                                                                                    Interface InnerNodeRefSkeletonInterface

                                                                                                                                                    interface InnerNodeRefSkeletonInterface {
                                                                                                                                                        _id: string;
                                                                                                                                                        displayName: string;
                                                                                                                                                        nodeType: string;
                                                                                                                                                    }
                                                                                                                                                    Index

                                                                                                                                                    Properties

                                                                                                                                                    _id +InnerNodeRefSkeletonInterface | Frodo Library - v4.0.0-11
                                                                                                                                                    Frodo Library - v4.0.0-11
                                                                                                                                                      Preparing search index...

                                                                                                                                                      Interface InnerNodeRefSkeletonInterface

                                                                                                                                                      interface InnerNodeRefSkeletonInterface {
                                                                                                                                                          _id: string;
                                                                                                                                                          displayName: string;
                                                                                                                                                          nodeType: string;
                                                                                                                                                      }
                                                                                                                                                      Index

                                                                                                                                                      Properties

                                                                                                                                                      _id: string
                                                                                                                                                      displayName: string
                                                                                                                                                      nodeType: string
                                                                                                                                                      +

                                                                                                                                                      Properties

                                                                                                                                                      _id: string
                                                                                                                                                      displayName: string
                                                                                                                                                      nodeType: string
                                                                                                                                                      diff --git a/docs/interfaces/Reference.InternalRoleExportInterface.html b/docs/interfaces/Reference.InternalRoleExportInterface.html index 3a9b0fd57..3f7012d0a 100644 --- a/docs/interfaces/Reference.InternalRoleExportInterface.html +++ b/docs/interfaces/Reference.InternalRoleExportInterface.html @@ -1,6 +1,6 @@ -InternalRoleExportInterface | Frodo Library - v4.0.0-10
                                                                                                                                                      Frodo Library - v4.0.0-10
                                                                                                                                                        Preparing search index...

                                                                                                                                                        Interface InternalRoleExportInterface

                                                                                                                                                        Export format for internal roles

                                                                                                                                                        -
                                                                                                                                                        interface InternalRoleExportInterface {
                                                                                                                                                            internalRole: Record<string, InternalRoleSkeleton>;
                                                                                                                                                            meta?: ExportMetaData;
                                                                                                                                                        }
                                                                                                                                                        Index

                                                                                                                                                        Properties

                                                                                                                                                        internalRole +InternalRoleExportInterface | Frodo Library - v4.0.0-11
                                                                                                                                                        Frodo Library - v4.0.0-11
                                                                                                                                                          Preparing search index...

                                                                                                                                                          Interface InternalRoleExportInterface

                                                                                                                                                          Export format for internal roles

                                                                                                                                                          +
                                                                                                                                                          interface InternalRoleExportInterface {
                                                                                                                                                              internalRole: Record<string, InternalRoleSkeleton>;
                                                                                                                                                              meta?: ExportMetaData;
                                                                                                                                                          }
                                                                                                                                                          Index

                                                                                                                                                          Properties

                                                                                                                                                          Properties

                                                                                                                                                          internalRole: Record<string, InternalRoleSkeleton>

                                                                                                                                                          Internal roles

                                                                                                                                                          -

                                                                                                                                                          Metadata

                                                                                                                                                          -
                                                                                                                                                          +

                                                                                                                                                          Metadata

                                                                                                                                                          +
                                                                                                                                                          diff --git a/docs/interfaces/Reference.JwkInterface.html b/docs/interfaces/Reference.JwkInterface.html index 29056b264..110e910a9 100644 --- a/docs/interfaces/Reference.JwkInterface.html +++ b/docs/interfaces/Reference.JwkInterface.html @@ -1,4 +1,4 @@ -JwkInterface | Frodo Library - v4.0.0-10
                                                                                                                                                          Frodo Library - v4.0.0-10
                                                                                                                                                            Preparing search index...

                                                                                                                                                            Interface JwkInterface

                                                                                                                                                            interface JwkInterface {
                                                                                                                                                                alg: string;
                                                                                                                                                                key_ops?: string[];
                                                                                                                                                                kid?: string;
                                                                                                                                                                kty: string;
                                                                                                                                                                use?: string;
                                                                                                                                                                x5c?: string;
                                                                                                                                                                x5t?: string;
                                                                                                                                                                "x5t#S256"?: string;
                                                                                                                                                                x5u?: string;
                                                                                                                                                            }
                                                                                                                                                            Index

                                                                                                                                                            Properties

                                                                                                                                                            alg +JwkInterface | Frodo Library - v4.0.0-11
                                                                                                                                                            Frodo Library - v4.0.0-11
                                                                                                                                                              Preparing search index...

                                                                                                                                                              Interface JwkInterface

                                                                                                                                                              interface JwkInterface {
                                                                                                                                                                  alg: string;
                                                                                                                                                                  key_ops?: string[];
                                                                                                                                                                  kid?: string;
                                                                                                                                                                  kty: string;
                                                                                                                                                                  use?: string;
                                                                                                                                                                  x5c?: string;
                                                                                                                                                                  x5t?: string;
                                                                                                                                                                  "x5t#S256"?: string;
                                                                                                                                                                  x5u?: string;
                                                                                                                                                              }
                                                                                                                                                              Index

                                                                                                                                                              Properties

                                                                                                                                                              alg key_ops? kid? kty @@ -7,4 +7,4 @@ x5t? x5t#S256? x5u? -

                                                                                                                                                              Properties

                                                                                                                                                              alg: string
                                                                                                                                                              key_ops?: string[]
                                                                                                                                                              kid?: string
                                                                                                                                                              kty: string
                                                                                                                                                              use?: string
                                                                                                                                                              x5c?: string
                                                                                                                                                              x5t?: string
                                                                                                                                                              "x5t#S256"?: string
                                                                                                                                                              x5u?: string
                                                                                                                                                              +

                                                                                                                                                              Properties

                                                                                                                                                              alg: string
                                                                                                                                                              key_ops?: string[]
                                                                                                                                                              kid?: string
                                                                                                                                                              kty: string
                                                                                                                                                              use?: string
                                                                                                                                                              x5c?: string
                                                                                                                                                              x5t?: string
                                                                                                                                                              "x5t#S256"?: string
                                                                                                                                                              x5u?: string
                                                                                                                                                              diff --git a/docs/interfaces/Reference.JwksInterface.html b/docs/interfaces/Reference.JwksInterface.html index 56dbdf7ef..7935a9a57 100644 --- a/docs/interfaces/Reference.JwksInterface.html +++ b/docs/interfaces/Reference.JwksInterface.html @@ -1,2 +1,2 @@ -JwksInterface | Frodo Library - v4.0.0-10
                                                                                                                                                              Frodo Library - v4.0.0-10
                                                                                                                                                                Preparing search index...

                                                                                                                                                                Interface JwksInterface

                                                                                                                                                                interface JwksInterface {
                                                                                                                                                                    keys: JwkInterface[];
                                                                                                                                                                }
                                                                                                                                                                Index

                                                                                                                                                                Properties

                                                                                                                                                                Properties

                                                                                                                                                                keys: JwkInterface[]
                                                                                                                                                                +JwksInterface | Frodo Library - v4.0.0-11
                                                                                                                                                                Frodo Library - v4.0.0-11
                                                                                                                                                                  Preparing search index...

                                                                                                                                                                  Interface JwksInterface

                                                                                                                                                                  interface JwksInterface {
                                                                                                                                                                      keys: JwkInterface[];
                                                                                                                                                                  }
                                                                                                                                                                  Index

                                                                                                                                                                  Properties

                                                                                                                                                                  Properties

                                                                                                                                                                  keys: JwkInterface[]
                                                                                                                                                                  diff --git a/docs/interfaces/Reference.MappingExportInterface.html b/docs/interfaces/Reference.MappingExportInterface.html index b6e42eb58..ef169961e 100644 --- a/docs/interfaces/Reference.MappingExportInterface.html +++ b/docs/interfaces/Reference.MappingExportInterface.html @@ -1,4 +1,4 @@ -MappingExportInterface | Frodo Library - v4.0.0-10
                                                                                                                                                                  Frodo Library - v4.0.0-10
                                                                                                                                                                    Preparing search index...

                                                                                                                                                                    Interface MappingExportInterface

                                                                                                                                                                    interface MappingExportInterface {
                                                                                                                                                                        mapping: Record<string, MappingSkeleton>;
                                                                                                                                                                        meta?: ExportMetaData;
                                                                                                                                                                        sync: SyncSkeleton;
                                                                                                                                                                    }
                                                                                                                                                                    Index

                                                                                                                                                                    Properties

                                                                                                                                                                    mapping +MappingExportInterface | Frodo Library - v4.0.0-11
                                                                                                                                                                    Frodo Library - v4.0.0-11
                                                                                                                                                                      Preparing search index...

                                                                                                                                                                      Interface MappingExportInterface

                                                                                                                                                                      interface MappingExportInterface {
                                                                                                                                                                          mapping: Record<string, MappingSkeleton>;
                                                                                                                                                                          meta?: ExportMetaData;
                                                                                                                                                                          sync: SyncSkeleton;
                                                                                                                                                                      }
                                                                                                                                                                      Index

                                                                                                                                                                      Properties

                                                                                                                                                                      Properties

                                                                                                                                                                      mapping: Record<string, MappingSkeleton>
                                                                                                                                                                      +

                                                                                                                                                                      Properties

                                                                                                                                                                      mapping: Record<string, MappingSkeleton>
                                                                                                                                                                      diff --git a/docs/interfaces/Reference.MappingExportOptions.html b/docs/interfaces/Reference.MappingExportOptions.html index cbe5f53d3..1bcba9327 100644 --- a/docs/interfaces/Reference.MappingExportOptions.html +++ b/docs/interfaces/Reference.MappingExportOptions.html @@ -1,10 +1,10 @@ -MappingExportOptions | Frodo Library - v4.0.0-10
                                                                                                                                                                      Frodo Library - v4.0.0-10
                                                                                                                                                                        Preparing search index...

                                                                                                                                                                        Interface MappingExportOptions

                                                                                                                                                                        Mapping export options

                                                                                                                                                                        -
                                                                                                                                                                        interface MappingExportOptions {
                                                                                                                                                                            connectorId?: string;
                                                                                                                                                                            deps: boolean;
                                                                                                                                                                            moType?: string;
                                                                                                                                                                            useStringArrays: boolean;
                                                                                                                                                                        }
                                                                                                                                                                        Index

                                                                                                                                                                        Properties

                                                                                                                                                                        connectorId? +MappingExportOptions | Frodo Library - v4.0.0-11
                                                                                                                                                                        Frodo Library - v4.0.0-11
                                                                                                                                                                          Preparing search index...

                                                                                                                                                                          Interface MappingExportOptions

                                                                                                                                                                          Mapping export options

                                                                                                                                                                          +
                                                                                                                                                                          interface MappingExportOptions {
                                                                                                                                                                              connectorId?: string;
                                                                                                                                                                              deps: boolean;
                                                                                                                                                                              moType?: string;
                                                                                                                                                                              useStringArrays: boolean;
                                                                                                                                                                          }
                                                                                                                                                                          Index

                                                                                                                                                                          Properties

                                                                                                                                                                          connectorId?: string

                                                                                                                                                                          limit mappings to connector

                                                                                                                                                                          -
                                                                                                                                                                          deps: boolean

                                                                                                                                                                          Include any dependencies.

                                                                                                                                                                          -
                                                                                                                                                                          moType?: string

                                                                                                                                                                          limit mappings to managed object type

                                                                                                                                                                          -
                                                                                                                                                                          useStringArrays: boolean

                                                                                                                                                                          Use string arrays to store multi-line text in scripts.

                                                                                                                                                                          -
                                                                                                                                                                          +
                                                                                                                                                                          deps: boolean

                                                                                                                                                                          Include any dependencies.

                                                                                                                                                                          +
                                                                                                                                                                          moType?: string

                                                                                                                                                                          limit mappings to managed object type

                                                                                                                                                                          +
                                                                                                                                                                          useStringArrays: boolean

                                                                                                                                                                          Use string arrays to store multi-line text in scripts.

                                                                                                                                                                          +
                                                                                                                                                                          diff --git a/docs/interfaces/Reference.MappingImportOptions.html b/docs/interfaces/Reference.MappingImportOptions.html index cbf158847..126aa2a9f 100644 --- a/docs/interfaces/Reference.MappingImportOptions.html +++ b/docs/interfaces/Reference.MappingImportOptions.html @@ -1,4 +1,4 @@ -MappingImportOptions | Frodo Library - v4.0.0-10
                                                                                                                                                                          Frodo Library - v4.0.0-10
                                                                                                                                                                            Preparing search index...

                                                                                                                                                                            Interface MappingImportOptions

                                                                                                                                                                            Mapping import options

                                                                                                                                                                            -
                                                                                                                                                                            interface MappingImportOptions {
                                                                                                                                                                                deps: boolean;
                                                                                                                                                                            }
                                                                                                                                                                            Index

                                                                                                                                                                            Properties

                                                                                                                                                                            deps +MappingImportOptions | Frodo Library - v4.0.0-11
                                                                                                                                                                            Frodo Library - v4.0.0-11
                                                                                                                                                                              Preparing search index...

                                                                                                                                                                              Interface MappingImportOptions

                                                                                                                                                                              Mapping import options

                                                                                                                                                                              +
                                                                                                                                                                              interface MappingImportOptions {
                                                                                                                                                                                  deps: boolean;
                                                                                                                                                                              }
                                                                                                                                                                              Index

                                                                                                                                                                              Properties

                                                                                                                                                                              Properties

                                                                                                                                                                              deps: boolean

                                                                                                                                                                              Include any dependencies.

                                                                                                                                                                              -
                                                                                                                                                                              +
                                                                                                                                                                              diff --git a/docs/interfaces/Reference.MultiTreeExportInterface.html b/docs/interfaces/Reference.MultiTreeExportInterface.html index d318503f4..06bd1a23d 100644 --- a/docs/interfaces/Reference.MultiTreeExportInterface.html +++ b/docs/interfaces/Reference.MultiTreeExportInterface.html @@ -1,3 +1,3 @@ -MultiTreeExportInterface | Frodo Library - v4.0.0-10
                                                                                                                                                                              Frodo Library - v4.0.0-10
                                                                                                                                                                                Preparing search index...

                                                                                                                                                                                Interface MultiTreeExportInterface

                                                                                                                                                                                interface MultiTreeExportInterface {
                                                                                                                                                                                    meta?: ExportMetaData;
                                                                                                                                                                                    trees: Record<string, SingleTreeExportInterface>;
                                                                                                                                                                                }
                                                                                                                                                                                Index

                                                                                                                                                                                Properties

                                                                                                                                                                                meta? +MultiTreeExportInterface | Frodo Library - v4.0.0-11
                                                                                                                                                                                Frodo Library - v4.0.0-11
                                                                                                                                                                                  Preparing search index...

                                                                                                                                                                                  Interface MultiTreeExportInterface

                                                                                                                                                                                  interface MultiTreeExportInterface {
                                                                                                                                                                                      meta?: ExportMetaData;
                                                                                                                                                                                      trees: Record<string, SingleTreeExportInterface>;
                                                                                                                                                                                  }
                                                                                                                                                                                  Index

                                                                                                                                                                                  Properties

                                                                                                                                                                                  Properties

                                                                                                                                                                                  trees: Record<string, SingleTreeExportInterface>
                                                                                                                                                                                  +

                                                                                                                                                                                  Properties

                                                                                                                                                                                  trees: Record<string, SingleTreeExportInterface>
                                                                                                                                                                                  diff --git a/docs/interfaces/Reference.NoIdObjectSkeletonInterface.html b/docs/interfaces/Reference.NoIdObjectSkeletonInterface.html index 0f87885d2..86aab7ebe 100644 --- a/docs/interfaces/Reference.NoIdObjectSkeletonInterface.html +++ b/docs/interfaces/Reference.NoIdObjectSkeletonInterface.html @@ -1,2 +1,2 @@ -NoIdObjectSkeletonInterface | Frodo Library - v4.0.0-10
                                                                                                                                                                                  Frodo Library - v4.0.0-10
                                                                                                                                                                                    Preparing search index...

                                                                                                                                                                                    Interface NoIdObjectSkeletonInterface

                                                                                                                                                                                    interface NoIdObjectSkeletonInterface {
                                                                                                                                                                                        _rev?: string;
                                                                                                                                                                                        [k: string]:
                                                                                                                                                                                            | string
                                                                                                                                                                                            | number
                                                                                                                                                                                            | boolean
                                                                                                                                                                                            | object
                                                                                                                                                                                            | string[]
                                                                                                                                                                                            | IdObjectSkeletonInterface;
                                                                                                                                                                                    }

                                                                                                                                                                                    Hierarchy (View Summary)

                                                                                                                                                                                    Indexable

                                                                                                                                                                                    Index

                                                                                                                                                                                    Properties

                                                                                                                                                                                    Properties

                                                                                                                                                                                    _rev?: string
                                                                                                                                                                                    +NoIdObjectSkeletonInterface | Frodo Library - v4.0.0-11
                                                                                                                                                                                    Frodo Library - v4.0.0-11
                                                                                                                                                                                      Preparing search index...

                                                                                                                                                                                      Interface NoIdObjectSkeletonInterface

                                                                                                                                                                                      interface NoIdObjectSkeletonInterface {
                                                                                                                                                                                          _rev?: string;
                                                                                                                                                                                          [k: string]:
                                                                                                                                                                                              | string
                                                                                                                                                                                              | number
                                                                                                                                                                                              | boolean
                                                                                                                                                                                              | object
                                                                                                                                                                                              | string[]
                                                                                                                                                                                              | IdObjectSkeletonInterface;
                                                                                                                                                                                      }

                                                                                                                                                                                      Hierarchy (View Summary)

                                                                                                                                                                                      Indexable

                                                                                                                                                                                      Index

                                                                                                                                                                                      Properties

                                                                                                                                                                                      Properties

                                                                                                                                                                                      _rev?: string
                                                                                                                                                                                      diff --git a/docs/interfaces/Reference.NodeExportInterface.html b/docs/interfaces/Reference.NodeExportInterface.html index 7f764448a..dcbcde1d9 100644 --- a/docs/interfaces/Reference.NodeExportInterface.html +++ b/docs/interfaces/Reference.NodeExportInterface.html @@ -1,3 +1,3 @@ -NodeExportInterface | Frodo Library - v4.0.0-10
                                                                                                                                                                                      Frodo Library - v4.0.0-10
                                                                                                                                                                                        Preparing search index...

                                                                                                                                                                                        Interface NodeExportInterface

                                                                                                                                                                                        interface NodeExportInterface {
                                                                                                                                                                                            meta?: ExportMetaData;
                                                                                                                                                                                            node: Record<string, NodeSkeleton>;
                                                                                                                                                                                        }
                                                                                                                                                                                        Index

                                                                                                                                                                                        Properties

                                                                                                                                                                                        meta? +NodeExportInterface | Frodo Library - v4.0.0-11
                                                                                                                                                                                        Frodo Library - v4.0.0-11
                                                                                                                                                                                          Preparing search index...

                                                                                                                                                                                          Interface NodeExportInterface

                                                                                                                                                                                          interface NodeExportInterface {
                                                                                                                                                                                              meta?: ExportMetaData;
                                                                                                                                                                                              node: Record<string, NodeSkeleton>;
                                                                                                                                                                                          }
                                                                                                                                                                                          Index

                                                                                                                                                                                          Properties

                                                                                                                                                                                          Properties

                                                                                                                                                                                          node: Record<string, NodeSkeleton>
                                                                                                                                                                                          +

                                                                                                                                                                                          Properties

                                                                                                                                                                                          node: Record<string, NodeSkeleton>
                                                                                                                                                                                          diff --git a/docs/interfaces/Reference.NodeRefSkeletonInterface.html b/docs/interfaces/Reference.NodeRefSkeletonInterface.html index e3a6c73ac..9ef479a13 100644 --- a/docs/interfaces/Reference.NodeRefSkeletonInterface.html +++ b/docs/interfaces/Reference.NodeRefSkeletonInterface.html @@ -1,6 +1,6 @@ -NodeRefSkeletonInterface | Frodo Library - v4.0.0-10
                                                                                                                                                                                          Frodo Library - v4.0.0-10
                                                                                                                                                                                            Preparing search index...

                                                                                                                                                                                            Interface NodeRefSkeletonInterface

                                                                                                                                                                                            interface NodeRefSkeletonInterface {
                                                                                                                                                                                                connections: Record<string, string>;
                                                                                                                                                                                                displayName: string;
                                                                                                                                                                                                nodeType: string;
                                                                                                                                                                                                x: number;
                                                                                                                                                                                                y: number;
                                                                                                                                                                                            }
                                                                                                                                                                                            Index

                                                                                                                                                                                            Properties

                                                                                                                                                                                            connections +NodeRefSkeletonInterface | Frodo Library - v4.0.0-11
                                                                                                                                                                                            Frodo Library - v4.0.0-11
                                                                                                                                                                                              Preparing search index...

                                                                                                                                                                                              Interface NodeRefSkeletonInterface

                                                                                                                                                                                              interface NodeRefSkeletonInterface {
                                                                                                                                                                                                  connections: Record<string, string>;
                                                                                                                                                                                                  displayName: string;
                                                                                                                                                                                                  nodeType: string;
                                                                                                                                                                                                  x: number;
                                                                                                                                                                                                  y: number;
                                                                                                                                                                                              }
                                                                                                                                                                                              Index

                                                                                                                                                                                              Properties

                                                                                                                                                                                              connections: Record<string, string>
                                                                                                                                                                                              displayName: string
                                                                                                                                                                                              nodeType: string
                                                                                                                                                                                              x: number
                                                                                                                                                                                              y: number
                                                                                                                                                                                              +

                                                                                                                                                                                              Properties

                                                                                                                                                                                              connections: Record<string, string>
                                                                                                                                                                                              displayName: string
                                                                                                                                                                                              nodeType: string
                                                                                                                                                                                              x: number
                                                                                                                                                                                              y: number
                                                                                                                                                                                              diff --git a/docs/interfaces/Reference.OAuth2ClientExportInterface.html b/docs/interfaces/Reference.OAuth2ClientExportInterface.html index 03113a048..8ec458a96 100644 --- a/docs/interfaces/Reference.OAuth2ClientExportInterface.html +++ b/docs/interfaces/Reference.OAuth2ClientExportInterface.html @@ -1,4 +1,4 @@ -OAuth2ClientExportInterface | Frodo Library - v4.0.0-10
                                                                                                                                                                                              Frodo Library - v4.0.0-10
                                                                                                                                                                                                Preparing search index...

                                                                                                                                                                                                Interface OAuth2ClientExportInterface

                                                                                                                                                                                                interface OAuth2ClientExportInterface {
                                                                                                                                                                                                    application: Record<string, OAuth2ClientSkeleton>;
                                                                                                                                                                                                    meta?: ExportMetaData;
                                                                                                                                                                                                    script?: Record<string, ScriptSkeleton>;
                                                                                                                                                                                                }
                                                                                                                                                                                                Index

                                                                                                                                                                                                Properties

                                                                                                                                                                                                application +OAuth2ClientExportInterface | Frodo Library - v4.0.0-11
                                                                                                                                                                                                Frodo Library - v4.0.0-11
                                                                                                                                                                                                  Preparing search index...

                                                                                                                                                                                                  Interface OAuth2ClientExportInterface

                                                                                                                                                                                                  interface OAuth2ClientExportInterface {
                                                                                                                                                                                                      application: Record<string, OAuth2ClientSkeleton>;
                                                                                                                                                                                                      meta?: ExportMetaData;
                                                                                                                                                                                                      script?: Record<string, ScriptSkeleton>;
                                                                                                                                                                                                  }
                                                                                                                                                                                                  Index

                                                                                                                                                                                                  Properties

                                                                                                                                                                                                  application: Record<string, OAuth2ClientSkeleton>
                                                                                                                                                                                                  script?: Record<string, ScriptSkeleton>
                                                                                                                                                                                                  +

                                                                                                                                                                                                  Properties

                                                                                                                                                                                                  application: Record<string, OAuth2ClientSkeleton>
                                                                                                                                                                                                  script?: Record<string, ScriptSkeleton>
                                                                                                                                                                                                  diff --git a/docs/interfaces/Reference.OAuth2ClientExportOptions.html b/docs/interfaces/Reference.OAuth2ClientExportOptions.html index 823f011b4..1a2756f54 100644 --- a/docs/interfaces/Reference.OAuth2ClientExportOptions.html +++ b/docs/interfaces/Reference.OAuth2ClientExportOptions.html @@ -1,6 +1,6 @@ -OAuth2ClientExportOptions | Frodo Library - v4.0.0-10
                                                                                                                                                                                                  Frodo Library - v4.0.0-10
                                                                                                                                                                                                    Preparing search index...

                                                                                                                                                                                                    Interface OAuth2ClientExportOptions

                                                                                                                                                                                                    OAuth2 client export options

                                                                                                                                                                                                    -
                                                                                                                                                                                                    interface OAuth2ClientExportOptions {
                                                                                                                                                                                                        deps: boolean;
                                                                                                                                                                                                        useStringArrays: boolean;
                                                                                                                                                                                                    }
                                                                                                                                                                                                    Index

                                                                                                                                                                                                    Properties

                                                                                                                                                                                                    deps +OAuth2ClientExportOptions | Frodo Library - v4.0.0-11
                                                                                                                                                                                                    Frodo Library - v4.0.0-11
                                                                                                                                                                                                      Preparing search index...

                                                                                                                                                                                                      Interface OAuth2ClientExportOptions

                                                                                                                                                                                                      OAuth2 client export options

                                                                                                                                                                                                      +
                                                                                                                                                                                                      interface OAuth2ClientExportOptions {
                                                                                                                                                                                                          deps: boolean;
                                                                                                                                                                                                          useStringArrays: boolean;
                                                                                                                                                                                                      }
                                                                                                                                                                                                      Index

                                                                                                                                                                                                      Properties

                                                                                                                                                                                                      deps: boolean

                                                                                                                                                                                                      Include any dependencies (scripts).

                                                                                                                                                                                                      -
                                                                                                                                                                                                      useStringArrays: boolean

                                                                                                                                                                                                      Use string arrays to store multi-line text in scripts.

                                                                                                                                                                                                      -
                                                                                                                                                                                                      +
                                                                                                                                                                                                      useStringArrays: boolean

                                                                                                                                                                                                      Use string arrays to store multi-line text in scripts.

                                                                                                                                                                                                      +
                                                                                                                                                                                                      diff --git a/docs/interfaces/Reference.OAuth2ClientImportOptions.html b/docs/interfaces/Reference.OAuth2ClientImportOptions.html index 6e75a8992..6643cfb9a 100644 --- a/docs/interfaces/Reference.OAuth2ClientImportOptions.html +++ b/docs/interfaces/Reference.OAuth2ClientImportOptions.html @@ -1,4 +1,4 @@ -OAuth2ClientImportOptions | Frodo Library - v4.0.0-10
                                                                                                                                                                                                      Frodo Library - v4.0.0-10
                                                                                                                                                                                                        Preparing search index...

                                                                                                                                                                                                        Interface OAuth2ClientImportOptions

                                                                                                                                                                                                        OAuth2 client import options

                                                                                                                                                                                                        -
                                                                                                                                                                                                        interface OAuth2ClientImportOptions {
                                                                                                                                                                                                            deps: boolean;
                                                                                                                                                                                                        }
                                                                                                                                                                                                        Index

                                                                                                                                                                                                        Properties

                                                                                                                                                                                                        deps +OAuth2ClientImportOptions | Frodo Library - v4.0.0-11
                                                                                                                                                                                                        Frodo Library - v4.0.0-11
                                                                                                                                                                                                          Preparing search index...

                                                                                                                                                                                                          Interface OAuth2ClientImportOptions

                                                                                                                                                                                                          OAuth2 client import options

                                                                                                                                                                                                          +
                                                                                                                                                                                                          interface OAuth2ClientImportOptions {
                                                                                                                                                                                                              deps: boolean;
                                                                                                                                                                                                          }
                                                                                                                                                                                                          Index

                                                                                                                                                                                                          Properties

                                                                                                                                                                                                          Properties

                                                                                                                                                                                                          deps: boolean

                                                                                                                                                                                                          Include any dependencies (scripts).

                                                                                                                                                                                                          -
                                                                                                                                                                                                          +
                                                                                                                                                                                                          diff --git a/docs/interfaces/Reference.OAuth2TrustedJwtIssuerExportInterface.html b/docs/interfaces/Reference.OAuth2TrustedJwtIssuerExportInterface.html index c81d9d478..fbc212898 100644 --- a/docs/interfaces/Reference.OAuth2TrustedJwtIssuerExportInterface.html +++ b/docs/interfaces/Reference.OAuth2TrustedJwtIssuerExportInterface.html @@ -1,3 +1,3 @@ -OAuth2TrustedJwtIssuerExportInterface | Frodo Library - v4.0.0-10
                                                                                                                                                                                                          Frodo Library - v4.0.0-10
                                                                                                                                                                                                            Preparing search index...

                                                                                                                                                                                                            Interface OAuth2TrustedJwtIssuerExportInterface

                                                                                                                                                                                                            interface OAuth2TrustedJwtIssuerExportInterface {
                                                                                                                                                                                                                meta?: ExportMetaData;
                                                                                                                                                                                                                trustedJwtIssuer: Record<string, OAuth2TrustedJwtIssuerSkeleton>;
                                                                                                                                                                                                            }
                                                                                                                                                                                                            Index

                                                                                                                                                                                                            Properties

                                                                                                                                                                                                            meta? +OAuth2TrustedJwtIssuerExportInterface | Frodo Library - v4.0.0-11
                                                                                                                                                                                                            Frodo Library - v4.0.0-11
                                                                                                                                                                                                              Preparing search index...

                                                                                                                                                                                                              Interface OAuth2TrustedJwtIssuerExportInterface

                                                                                                                                                                                                              interface OAuth2TrustedJwtIssuerExportInterface {
                                                                                                                                                                                                                  meta?: ExportMetaData;
                                                                                                                                                                                                                  trustedJwtIssuer: Record<string, OAuth2TrustedJwtIssuerSkeleton>;
                                                                                                                                                                                                              }
                                                                                                                                                                                                              Index

                                                                                                                                                                                                              Properties

                                                                                                                                                                                                              trustedJwtIssuer: Record<string, OAuth2TrustedJwtIssuerSkeleton>
                                                                                                                                                                                                              +

                                                                                                                                                                                                              Properties

                                                                                                                                                                                                              trustedJwtIssuer: Record<string, OAuth2TrustedJwtIssuerSkeleton>
                                                                                                                                                                                                              diff --git a/docs/interfaces/Reference.OAuth2TrustedJwtIssuerExportOptions.html b/docs/interfaces/Reference.OAuth2TrustedJwtIssuerExportOptions.html index c311f6682..45e17b95e 100644 --- a/docs/interfaces/Reference.OAuth2TrustedJwtIssuerExportOptions.html +++ b/docs/interfaces/Reference.OAuth2TrustedJwtIssuerExportOptions.html @@ -1,6 +1,6 @@ -OAuth2TrustedJwtIssuerExportOptions | Frodo Library - v4.0.0-10
                                                                                                                                                                                                              Frodo Library - v4.0.0-10
                                                                                                                                                                                                                Preparing search index...

                                                                                                                                                                                                                Interface OAuth2TrustedJwtIssuerExportOptions

                                                                                                                                                                                                                OAuth2 trusted jwt issuer export options

                                                                                                                                                                                                                -
                                                                                                                                                                                                                interface OAuth2TrustedJwtIssuerExportOptions {
                                                                                                                                                                                                                    deps: boolean;
                                                                                                                                                                                                                    useStringArrays: boolean;
                                                                                                                                                                                                                }
                                                                                                                                                                                                                Index

                                                                                                                                                                                                                Properties

                                                                                                                                                                                                                deps +OAuth2TrustedJwtIssuerExportOptions | Frodo Library - v4.0.0-11
                                                                                                                                                                                                                Frodo Library - v4.0.0-11
                                                                                                                                                                                                                  Preparing search index...

                                                                                                                                                                                                                  Interface OAuth2TrustedJwtIssuerExportOptions

                                                                                                                                                                                                                  OAuth2 trusted jwt issuer export options

                                                                                                                                                                                                                  +
                                                                                                                                                                                                                  interface OAuth2TrustedJwtIssuerExportOptions {
                                                                                                                                                                                                                      deps: boolean;
                                                                                                                                                                                                                      useStringArrays: boolean;
                                                                                                                                                                                                                  }
                                                                                                                                                                                                                  Index

                                                                                                                                                                                                                  Properties

                                                                                                                                                                                                                  deps: boolean

                                                                                                                                                                                                                  Include any dependencies (scripts).

                                                                                                                                                                                                                  -
                                                                                                                                                                                                                  useStringArrays: boolean

                                                                                                                                                                                                                  Use string arrays to store multi-line text in scripts.

                                                                                                                                                                                                                  -
                                                                                                                                                                                                                  +
                                                                                                                                                                                                                  useStringArrays: boolean

                                                                                                                                                                                                                  Use string arrays to store multi-line text in scripts.

                                                                                                                                                                                                                  +
                                                                                                                                                                                                                  diff --git a/docs/interfaces/Reference.OAuth2TrustedJwtIssuerImportOptions.html b/docs/interfaces/Reference.OAuth2TrustedJwtIssuerImportOptions.html index 9122dc63a..6f4eddac5 100644 --- a/docs/interfaces/Reference.OAuth2TrustedJwtIssuerImportOptions.html +++ b/docs/interfaces/Reference.OAuth2TrustedJwtIssuerImportOptions.html @@ -1,4 +1,4 @@ -OAuth2TrustedJwtIssuerImportOptions | Frodo Library - v4.0.0-10
                                                                                                                                                                                                                  Frodo Library - v4.0.0-10
                                                                                                                                                                                                                    Preparing search index...

                                                                                                                                                                                                                    Interface OAuth2TrustedJwtIssuerImportOptions

                                                                                                                                                                                                                    OAuth2 trusted jwt issuer import options

                                                                                                                                                                                                                    -
                                                                                                                                                                                                                    interface OAuth2TrustedJwtIssuerImportOptions {
                                                                                                                                                                                                                        deps: boolean;
                                                                                                                                                                                                                    }
                                                                                                                                                                                                                    Index

                                                                                                                                                                                                                    Properties

                                                                                                                                                                                                                    deps +OAuth2TrustedJwtIssuerImportOptions | Frodo Library - v4.0.0-11
                                                                                                                                                                                                                    Frodo Library - v4.0.0-11
                                                                                                                                                                                                                      Preparing search index...

                                                                                                                                                                                                                      Interface OAuth2TrustedJwtIssuerImportOptions

                                                                                                                                                                                                                      OAuth2 trusted jwt issuer import options

                                                                                                                                                                                                                      +
                                                                                                                                                                                                                      interface OAuth2TrustedJwtIssuerImportOptions {
                                                                                                                                                                                                                          deps: boolean;
                                                                                                                                                                                                                      }
                                                                                                                                                                                                                      Index

                                                                                                                                                                                                                      Properties

                                                                                                                                                                                                                      Properties

                                                                                                                                                                                                                      deps: boolean

                                                                                                                                                                                                                      Include any dependencies (scripts).

                                                                                                                                                                                                                      -
                                                                                                                                                                                                                      +
                                                                                                                                                                                                                      diff --git a/docs/interfaces/Reference.PatchOperationInterface.html b/docs/interfaces/Reference.PatchOperationInterface.html index cf452ce8d..4818ac232 100644 --- a/docs/interfaces/Reference.PatchOperationInterface.html +++ b/docs/interfaces/Reference.PatchOperationInterface.html @@ -1,6 +1,6 @@ -PatchOperationInterface | Frodo Library - v4.0.0-10
                                                                                                                                                                                                                      Frodo Library - v4.0.0-10
                                                                                                                                                                                                                        Preparing search index...

                                                                                                                                                                                                                        Interface PatchOperationInterface

                                                                                                                                                                                                                        interface PatchOperationInterface {
                                                                                                                                                                                                                            field: string;
                                                                                                                                                                                                                            from?: string;
                                                                                                                                                                                                                            operation:
                                                                                                                                                                                                                                | "add"
                                                                                                                                                                                                                                | "copy"
                                                                                                                                                                                                                                | "increment"
                                                                                                                                                                                                                                | "move"
                                                                                                                                                                                                                                | "remove"
                                                                                                                                                                                                                                | "replace"
                                                                                                                                                                                                                                | "transform";
                                                                                                                                                                                                                            value?: any;
                                                                                                                                                                                                                        }
                                                                                                                                                                                                                        Index

                                                                                                                                                                                                                        Properties

                                                                                                                                                                                                                        field +PatchOperationInterface | Frodo Library - v4.0.0-11
                                                                                                                                                                                                                        Frodo Library - v4.0.0-11
                                                                                                                                                                                                                          Preparing search index...

                                                                                                                                                                                                                          Interface PatchOperationInterface

                                                                                                                                                                                                                          interface PatchOperationInterface {
                                                                                                                                                                                                                              field: string;
                                                                                                                                                                                                                              from?: string;
                                                                                                                                                                                                                              operation:
                                                                                                                                                                                                                                  | "add"
                                                                                                                                                                                                                                  | "copy"
                                                                                                                                                                                                                                  | "increment"
                                                                                                                                                                                                                                  | "move"
                                                                                                                                                                                                                                  | "remove"
                                                                                                                                                                                                                                  | "replace"
                                                                                                                                                                                                                                  | "transform";
                                                                                                                                                                                                                              value?: any;
                                                                                                                                                                                                                          }
                                                                                                                                                                                                                          Index

                                                                                                                                                                                                                          Properties

                                                                                                                                                                                                                          field: string
                                                                                                                                                                                                                          from?: string
                                                                                                                                                                                                                          operation:
                                                                                                                                                                                                                              | "add"
                                                                                                                                                                                                                              | "copy"
                                                                                                                                                                                                                              | "increment"
                                                                                                                                                                                                                              | "move"
                                                                                                                                                                                                                              | "remove"
                                                                                                                                                                                                                              | "replace"
                                                                                                                                                                                                                              | "transform"
                                                                                                                                                                                                                          value?: any
                                                                                                                                                                                                                          +

                                                                                                                                                                                                                          Properties

                                                                                                                                                                                                                          field: string
                                                                                                                                                                                                                          from?: string
                                                                                                                                                                                                                          operation:
                                                                                                                                                                                                                              | "add"
                                                                                                                                                                                                                              | "copy"
                                                                                                                                                                                                                              | "increment"
                                                                                                                                                                                                                              | "move"
                                                                                                                                                                                                                              | "remove"
                                                                                                                                                                                                                              | "replace"
                                                                                                                                                                                                                              | "transform"
                                                                                                                                                                                                                          value?: any
                                                                                                                                                                                                                          diff --git a/docs/interfaces/Reference.PlatformInfoInterface.html b/docs/interfaces/Reference.PlatformInfoInterface.html index 3ccbcf7f8..f45f1ad37 100644 --- a/docs/interfaces/Reference.PlatformInfoInterface.html +++ b/docs/interfaces/Reference.PlatformInfoInterface.html @@ -1,8 +1,8 @@ -PlatformInfoInterface | Frodo Library - v4.0.0-10
                                                                                                                                                                                                                          Frodo Library - v4.0.0-10
                                                                                                                                                                                                                            Preparing search index...

                                                                                                                                                                                                                            Interface PlatformInfoInterface

                                                                                                                                                                                                                            interface PlatformInfoInterface {
                                                                                                                                                                                                                                amVersion: string;
                                                                                                                                                                                                                                authenticatedSubject: string;
                                                                                                                                                                                                                                bearerToken?: string;
                                                                                                                                                                                                                                cookieName: string;
                                                                                                                                                                                                                                deploymentType: string;
                                                                                                                                                                                                                                host: string;
                                                                                                                                                                                                                                sessionToken: string;
                                                                                                                                                                                                                            }
                                                                                                                                                                                                                            Index

                                                                                                                                                                                                                            Properties

                                                                                                                                                                                                                            amVersion +PlatformInfoInterface | Frodo Library - v4.0.0-11
                                                                                                                                                                                                                            Frodo Library - v4.0.0-11
                                                                                                                                                                                                                              Preparing search index...

                                                                                                                                                                                                                              Interface PlatformInfoInterface

                                                                                                                                                                                                                              interface PlatformInfoInterface {
                                                                                                                                                                                                                                  amVersion: string;
                                                                                                                                                                                                                                  authenticatedSubject: string;
                                                                                                                                                                                                                                  bearerToken?: string;
                                                                                                                                                                                                                                  cookieName: string;
                                                                                                                                                                                                                                  deploymentType: string;
                                                                                                                                                                                                                                  host: string;
                                                                                                                                                                                                                                  sessionToken: string;
                                                                                                                                                                                                                              }
                                                                                                                                                                                                                              Index

                                                                                                                                                                                                                              Properties

                                                                                                                                                                                                                              amVersion: string
                                                                                                                                                                                                                              authenticatedSubject: string
                                                                                                                                                                                                                              bearerToken?: string
                                                                                                                                                                                                                              cookieName: string
                                                                                                                                                                                                                              deploymentType: string
                                                                                                                                                                                                                              host: string
                                                                                                                                                                                                                              sessionToken: string
                                                                                                                                                                                                                              +

                                                                                                                                                                                                                              Properties

                                                                                                                                                                                                                              amVersion: string
                                                                                                                                                                                                                              authenticatedSubject: string
                                                                                                                                                                                                                              bearerToken?: string
                                                                                                                                                                                                                              cookieName: string
                                                                                                                                                                                                                              deploymentType: string
                                                                                                                                                                                                                              host: string
                                                                                                                                                                                                                              sessionToken: string
                                                                                                                                                                                                                              diff --git a/docs/interfaces/Reference.PolicyExportInterface.html b/docs/interfaces/Reference.PolicyExportInterface.html index 488155d64..7d96e0df3 100644 --- a/docs/interfaces/Reference.PolicyExportInterface.html +++ b/docs/interfaces/Reference.PolicyExportInterface.html @@ -1,6 +1,6 @@ -PolicyExportInterface | Frodo Library - v4.0.0-10
                                                                                                                                                                                                                              Frodo Library - v4.0.0-10
                                                                                                                                                                                                                                Preparing search index...

                                                                                                                                                                                                                                Interface PolicyExportInterface

                                                                                                                                                                                                                                interface PolicyExportInterface {
                                                                                                                                                                                                                                    meta?: ExportMetaData;
                                                                                                                                                                                                                                    policy: Record<string, PolicySkeleton>;
                                                                                                                                                                                                                                    policyset: Record<string, PolicySetSkeleton>;
                                                                                                                                                                                                                                    resourcetype: Record<string, ResourceTypeSkeleton>;
                                                                                                                                                                                                                                    script: Record<string, ScriptSkeleton>;
                                                                                                                                                                                                                                }
                                                                                                                                                                                                                                Index

                                                                                                                                                                                                                                Properties

                                                                                                                                                                                                                                meta? +PolicyExportInterface | Frodo Library - v4.0.0-11
                                                                                                                                                                                                                                Frodo Library - v4.0.0-11
                                                                                                                                                                                                                                  Preparing search index...

                                                                                                                                                                                                                                  Interface PolicyExportInterface

                                                                                                                                                                                                                                  interface PolicyExportInterface {
                                                                                                                                                                                                                                      meta?: ExportMetaData;
                                                                                                                                                                                                                                      policy: Record<string, PolicySkeleton>;
                                                                                                                                                                                                                                      policyset: Record<string, PolicySetSkeleton>;
                                                                                                                                                                                                                                      resourcetype: Record<string, ResourceTypeSkeleton>;
                                                                                                                                                                                                                                      script: Record<string, ScriptSkeleton>;
                                                                                                                                                                                                                                  }
                                                                                                                                                                                                                                  Index

                                                                                                                                                                                                                                  Properties

                                                                                                                                                                                                                                  policy: Record<string, PolicySkeleton>
                                                                                                                                                                                                                                  policyset: Record<string, PolicySetSkeleton>
                                                                                                                                                                                                                                  resourcetype: Record<string, ResourceTypeSkeleton>
                                                                                                                                                                                                                                  script: Record<string, ScriptSkeleton>
                                                                                                                                                                                                                                  +

                                                                                                                                                                                                                                  Properties

                                                                                                                                                                                                                                  policy: Record<string, PolicySkeleton>
                                                                                                                                                                                                                                  policyset: Record<string, PolicySetSkeleton>
                                                                                                                                                                                                                                  resourcetype: Record<string, ResourceTypeSkeleton>
                                                                                                                                                                                                                                  script: Record<string, ScriptSkeleton>
                                                                                                                                                                                                                                  diff --git a/docs/interfaces/Reference.PolicyExportOptions.html b/docs/interfaces/Reference.PolicyExportOptions.html index 3c333068e..8e95663f3 100644 --- a/docs/interfaces/Reference.PolicyExportOptions.html +++ b/docs/interfaces/Reference.PolicyExportOptions.html @@ -1,8 +1,8 @@ -PolicyExportOptions | Frodo Library - v4.0.0-10
                                                                                                                                                                                                                                  Frodo Library - v4.0.0-10
                                                                                                                                                                                                                                    Preparing search index...

                                                                                                                                                                                                                                    Interface PolicyExportOptions

                                                                                                                                                                                                                                    Policy export options

                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                    interface PolicyExportOptions {
                                                                                                                                                                                                                                        deps: boolean;
                                                                                                                                                                                                                                        prereqs: boolean;
                                                                                                                                                                                                                                        useStringArrays: boolean;
                                                                                                                                                                                                                                    }
                                                                                                                                                                                                                                    Index

                                                                                                                                                                                                                                    Properties

                                                                                                                                                                                                                                    deps +PolicyExportOptions | Frodo Library - v4.0.0-11
                                                                                                                                                                                                                                    Frodo Library - v4.0.0-11
                                                                                                                                                                                                                                      Preparing search index...

                                                                                                                                                                                                                                      Interface PolicyExportOptions

                                                                                                                                                                                                                                      Policy export options

                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                      interface PolicyExportOptions {
                                                                                                                                                                                                                                          deps: boolean;
                                                                                                                                                                                                                                          prereqs: boolean;
                                                                                                                                                                                                                                          useStringArrays: boolean;
                                                                                                                                                                                                                                      }
                                                                                                                                                                                                                                      Index

                                                                                                                                                                                                                                      Properties

                                                                                                                                                                                                                                      deps: boolean

                                                                                                                                                                                                                                      Include any dependencies (scripts).

                                                                                                                                                                                                                                      -
                                                                                                                                                                                                                                      prereqs: boolean

                                                                                                                                                                                                                                      Include any prerequisites (policy sets, resource types).

                                                                                                                                                                                                                                      -
                                                                                                                                                                                                                                      useStringArrays: boolean

                                                                                                                                                                                                                                      Use string arrays to store multi-line text in scripts.

                                                                                                                                                                                                                                      -
                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                      prereqs: boolean

                                                                                                                                                                                                                                      Include any prerequisites (policy sets, resource types).

                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                      useStringArrays: boolean

                                                                                                                                                                                                                                      Use string arrays to store multi-line text in scripts.

                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                      diff --git a/docs/interfaces/Reference.PolicyImportOptions.html b/docs/interfaces/Reference.PolicyImportOptions.html index e7950027f..3979b2cdc 100644 --- a/docs/interfaces/Reference.PolicyImportOptions.html +++ b/docs/interfaces/Reference.PolicyImportOptions.html @@ -1,8 +1,8 @@ -PolicyImportOptions | Frodo Library - v4.0.0-10
                                                                                                                                                                                                                                      Frodo Library - v4.0.0-10
                                                                                                                                                                                                                                        Preparing search index...

                                                                                                                                                                                                                                        Interface PolicyImportOptions

                                                                                                                                                                                                                                        Policy import options

                                                                                                                                                                                                                                        -
                                                                                                                                                                                                                                        interface PolicyImportOptions {
                                                                                                                                                                                                                                            deps: boolean;
                                                                                                                                                                                                                                            policySetName?: string;
                                                                                                                                                                                                                                            prereqs: boolean;
                                                                                                                                                                                                                                        }
                                                                                                                                                                                                                                        Index

                                                                                                                                                                                                                                        Properties

                                                                                                                                                                                                                                        deps +PolicyImportOptions | Frodo Library - v4.0.0-11
                                                                                                                                                                                                                                        Frodo Library - v4.0.0-11
                                                                                                                                                                                                                                          Preparing search index...

                                                                                                                                                                                                                                          Interface PolicyImportOptions

                                                                                                                                                                                                                                          Policy import options

                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                          interface PolicyImportOptions {
                                                                                                                                                                                                                                              deps: boolean;
                                                                                                                                                                                                                                              policySetName?: string;
                                                                                                                                                                                                                                              prereqs: boolean;
                                                                                                                                                                                                                                          }
                                                                                                                                                                                                                                          Index

                                                                                                                                                                                                                                          Properties

                                                                                                                                                                                                                                          deps: boolean

                                                                                                                                                                                                                                          Include any dependencies (scripts).

                                                                                                                                                                                                                                          -
                                                                                                                                                                                                                                          policySetName?: string

                                                                                                                                                                                                                                          Import policies into different policy set

                                                                                                                                                                                                                                          -
                                                                                                                                                                                                                                          prereqs: boolean

                                                                                                                                                                                                                                          Include any prerequisites (policy sets, resource types).

                                                                                                                                                                                                                                          -
                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                          policySetName?: string

                                                                                                                                                                                                                                          Import policies into different policy set

                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                          prereqs: boolean

                                                                                                                                                                                                                                          Include any prerequisites (policy sets, resource types).

                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                          diff --git a/docs/interfaces/Reference.PolicySetExportInterface.html b/docs/interfaces/Reference.PolicySetExportInterface.html index 9f776dfd6..ba79455d8 100644 --- a/docs/interfaces/Reference.PolicySetExportInterface.html +++ b/docs/interfaces/Reference.PolicySetExportInterface.html @@ -1,6 +1,6 @@ -PolicySetExportInterface | Frodo Library - v4.0.0-10
                                                                                                                                                                                                                                          Frodo Library - v4.0.0-10
                                                                                                                                                                                                                                            Preparing search index...

                                                                                                                                                                                                                                            Interface PolicySetExportInterface

                                                                                                                                                                                                                                            interface PolicySetExportInterface {
                                                                                                                                                                                                                                                meta?: ExportMetaData;
                                                                                                                                                                                                                                                policy: Record<string, PolicySkeleton>;
                                                                                                                                                                                                                                                policyset: Record<string, PolicySetSkeleton>;
                                                                                                                                                                                                                                                resourcetype: Record<string, ResourceTypeSkeleton>;
                                                                                                                                                                                                                                                script: Record<string, ScriptSkeleton>;
                                                                                                                                                                                                                                            }
                                                                                                                                                                                                                                            Index

                                                                                                                                                                                                                                            Properties

                                                                                                                                                                                                                                            meta? +PolicySetExportInterface | Frodo Library - v4.0.0-11
                                                                                                                                                                                                                                            Frodo Library - v4.0.0-11
                                                                                                                                                                                                                                              Preparing search index...

                                                                                                                                                                                                                                              Interface PolicySetExportInterface

                                                                                                                                                                                                                                              interface PolicySetExportInterface {
                                                                                                                                                                                                                                                  meta?: ExportMetaData;
                                                                                                                                                                                                                                                  policy: Record<string, PolicySkeleton>;
                                                                                                                                                                                                                                                  policyset: Record<string, PolicySetSkeleton>;
                                                                                                                                                                                                                                                  resourcetype: Record<string, ResourceTypeSkeleton>;
                                                                                                                                                                                                                                                  script: Record<string, ScriptSkeleton>;
                                                                                                                                                                                                                                              }
                                                                                                                                                                                                                                              Index

                                                                                                                                                                                                                                              Properties

                                                                                                                                                                                                                                              policy: Record<string, PolicySkeleton>
                                                                                                                                                                                                                                              policyset: Record<string, PolicySetSkeleton>
                                                                                                                                                                                                                                              resourcetype: Record<string, ResourceTypeSkeleton>
                                                                                                                                                                                                                                              script: Record<string, ScriptSkeleton>
                                                                                                                                                                                                                                              +

                                                                                                                                                                                                                                              Properties

                                                                                                                                                                                                                                              policy: Record<string, PolicySkeleton>
                                                                                                                                                                                                                                              policyset: Record<string, PolicySetSkeleton>
                                                                                                                                                                                                                                              resourcetype: Record<string, ResourceTypeSkeleton>
                                                                                                                                                                                                                                              script: Record<string, ScriptSkeleton>
                                                                                                                                                                                                                                              diff --git a/docs/interfaces/Reference.PolicySetExportOptions.html b/docs/interfaces/Reference.PolicySetExportOptions.html index 4be62eb6c..53401552e 100644 --- a/docs/interfaces/Reference.PolicySetExportOptions.html +++ b/docs/interfaces/Reference.PolicySetExportOptions.html @@ -1,8 +1,8 @@ -PolicySetExportOptions | Frodo Library - v4.0.0-10
                                                                                                                                                                                                                                              Frodo Library - v4.0.0-10
                                                                                                                                                                                                                                                Preparing search index...

                                                                                                                                                                                                                                                Interface PolicySetExportOptions

                                                                                                                                                                                                                                                Application/policy set export options

                                                                                                                                                                                                                                                -
                                                                                                                                                                                                                                                interface PolicySetExportOptions {
                                                                                                                                                                                                                                                    deps: boolean;
                                                                                                                                                                                                                                                    prereqs: boolean;
                                                                                                                                                                                                                                                    useStringArrays: boolean;
                                                                                                                                                                                                                                                }
                                                                                                                                                                                                                                                Index

                                                                                                                                                                                                                                                Properties

                                                                                                                                                                                                                                                deps +PolicySetExportOptions | Frodo Library - v4.0.0-11
                                                                                                                                                                                                                                                Frodo Library - v4.0.0-11
                                                                                                                                                                                                                                                  Preparing search index...

                                                                                                                                                                                                                                                  Interface PolicySetExportOptions

                                                                                                                                                                                                                                                  Application/policy set export options

                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                  interface PolicySetExportOptions {
                                                                                                                                                                                                                                                      deps: boolean;
                                                                                                                                                                                                                                                      prereqs: boolean;
                                                                                                                                                                                                                                                      useStringArrays: boolean;
                                                                                                                                                                                                                                                  }
                                                                                                                                                                                                                                                  Index

                                                                                                                                                                                                                                                  Properties

                                                                                                                                                                                                                                                  deps: boolean

                                                                                                                                                                                                                                                  Include any dependencies (policies, scripts, resource types).

                                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                                  prereqs: boolean

                                                                                                                                                                                                                                                  Include any prerequisites (policy sets, resource types).

                                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                                  useStringArrays: boolean

                                                                                                                                                                                                                                                  Use string arrays to store multi-line text in scripts.

                                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                  prereqs: boolean

                                                                                                                                                                                                                                                  Include any prerequisites (policy sets, resource types).

                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                  useStringArrays: boolean

                                                                                                                                                                                                                                                  Use string arrays to store multi-line text in scripts.

                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                  diff --git a/docs/interfaces/Reference.PolicySetImportOptions.html b/docs/interfaces/Reference.PolicySetImportOptions.html index 6815aa58c..18c2dcb3c 100644 --- a/docs/interfaces/Reference.PolicySetImportOptions.html +++ b/docs/interfaces/Reference.PolicySetImportOptions.html @@ -1,6 +1,6 @@ -PolicySetImportOptions | Frodo Library - v4.0.0-10
                                                                                                                                                                                                                                                  Frodo Library - v4.0.0-10
                                                                                                                                                                                                                                                    Preparing search index...

                                                                                                                                                                                                                                                    Interface PolicySetImportOptions

                                                                                                                                                                                                                                                    Policy set import options

                                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                                    interface PolicySetImportOptions {
                                                                                                                                                                                                                                                        deps: boolean;
                                                                                                                                                                                                                                                        prereqs: boolean;
                                                                                                                                                                                                                                                    }
                                                                                                                                                                                                                                                    Index

                                                                                                                                                                                                                                                    Properties

                                                                                                                                                                                                                                                    deps +PolicySetImportOptions | Frodo Library - v4.0.0-11
                                                                                                                                                                                                                                                    Frodo Library - v4.0.0-11
                                                                                                                                                                                                                                                      Preparing search index...

                                                                                                                                                                                                                                                      Interface PolicySetImportOptions

                                                                                                                                                                                                                                                      Policy set import options

                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                      interface PolicySetImportOptions {
                                                                                                                                                                                                                                                          deps: boolean;
                                                                                                                                                                                                                                                          prereqs: boolean;
                                                                                                                                                                                                                                                      }
                                                                                                                                                                                                                                                      Index

                                                                                                                                                                                                                                                      Properties

                                                                                                                                                                                                                                                      Properties

                                                                                                                                                                                                                                                      deps: boolean

                                                                                                                                                                                                                                                      Include any dependencies (policies, scripts, resource types).

                                                                                                                                                                                                                                                      -
                                                                                                                                                                                                                                                      prereqs: boolean

                                                                                                                                                                                                                                                      Include any prerequisites (policy sets, resource types).

                                                                                                                                                                                                                                                      -
                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                      prereqs: boolean

                                                                                                                                                                                                                                                      Include any prerequisites (policy sets, resource types).

                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                      diff --git a/docs/interfaces/Reference.RawExportOptions.html b/docs/interfaces/Reference.RawExportOptions.html index 17655e5ed..8e1c58b0f 100644 --- a/docs/interfaces/Reference.RawExportOptions.html +++ b/docs/interfaces/Reference.RawExportOptions.html @@ -1,8 +1,8 @@ -RawExportOptions | Frodo Library - v4.0.0-10
                                                                                                                                                                                                                                                      Frodo Library - v4.0.0-10
                                                                                                                                                                                                                                                        Preparing search index...

                                                                                                                                                                                                                                                        Interface RawExportOptions

                                                                                                                                                                                                                                                        Raw config export options from fr-config-manager (https://github.com/ForgeRock/fr-config-manager/blob/main/docs/raw.md)

                                                                                                                                                                                                                                                        -
                                                                                                                                                                                                                                                        interface RawExportOptions {
                                                                                                                                                                                                                                                            overrides?: IdObjectSkeletonInterface;
                                                                                                                                                                                                                                                            path: string;
                                                                                                                                                                                                                                                            pushApiVersion?: ApiVersion;
                                                                                                                                                                                                                                                        }
                                                                                                                                                                                                                                                        Index

                                                                                                                                                                                                                                                        Properties

                                                                                                                                                                                                                                                        overrides? +RawExportOptions | Frodo Library - v4.0.0-11
                                                                                                                                                                                                                                                        Frodo Library - v4.0.0-11
                                                                                                                                                                                                                                                          Preparing search index...

                                                                                                                                                                                                                                                          Interface RawExportOptions

                                                                                                                                                                                                                                                          Raw config export options from fr-config-manager (https://github.com/ForgeRock/fr-config-manager/blob/main/docs/raw.md)

                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                          interface RawExportOptions {
                                                                                                                                                                                                                                                              overrides?: IdObjectSkeletonInterface;
                                                                                                                                                                                                                                                              path: string;
                                                                                                                                                                                                                                                              pushApiVersion?: ApiVersion;
                                                                                                                                                                                                                                                          }
                                                                                                                                                                                                                                                          Index

                                                                                                                                                                                                                                                          Properties

                                                                                                                                                                                                                                                          An optional partial configuration object which should override the corresponding properties of the object exported from the tenant.

                                                                                                                                                                                                                                                          -
                                                                                                                                                                                                                                                          path: string

                                                                                                                                                                                                                                                          The URL path for the configuration object, relative to the tenant base URL

                                                                                                                                                                                                                                                          -
                                                                                                                                                                                                                                                          pushApiVersion?: ApiVersion

                                                                                                                                                                                                                                                          An optional object containing the properties 'protocol' and 'resource' to be used in the API version header. This allows specific values for specific configuration. The default is { protocol: "2.0". resource: "1.0" }. Only used for configuration under /am or /environment

                                                                                                                                                                                                                                                          -
                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                          path: string

                                                                                                                                                                                                                                                          The URL path for the configuration object, relative to the tenant base URL

                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                          pushApiVersion?: ApiVersion

                                                                                                                                                                                                                                                          An optional object containing the properties 'protocol' and 'resource' to be used in the API version header. This allows specific values for specific configuration. The default is { protocol: "2.0". resource: "1.0" }. Only used for configuration under /am or /environment

                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                          diff --git a/docs/interfaces/Reference.RealmExportInterface.html b/docs/interfaces/Reference.RealmExportInterface.html index 41daa433b..3ee1d6fb5 100644 --- a/docs/interfaces/Reference.RealmExportInterface.html +++ b/docs/interfaces/Reference.RealmExportInterface.html @@ -1,3 +1,3 @@ -RealmExportInterface | Frodo Library - v4.0.0-10
                                                                                                                                                                                                                                                          Frodo Library - v4.0.0-10
                                                                                                                                                                                                                                                            Preparing search index...

                                                                                                                                                                                                                                                            Interface RealmExportInterface

                                                                                                                                                                                                                                                            interface RealmExportInterface {
                                                                                                                                                                                                                                                                meta?: ExportMetaData;
                                                                                                                                                                                                                                                                realm: Record<string, RealmSkeleton>;
                                                                                                                                                                                                                                                            }
                                                                                                                                                                                                                                                            Index

                                                                                                                                                                                                                                                            Properties

                                                                                                                                                                                                                                                            meta? +RealmExportInterface | Frodo Library - v4.0.0-11
                                                                                                                                                                                                                                                            Frodo Library - v4.0.0-11
                                                                                                                                                                                                                                                              Preparing search index...

                                                                                                                                                                                                                                                              Interface RealmExportInterface

                                                                                                                                                                                                                                                              interface RealmExportInterface {
                                                                                                                                                                                                                                                                  meta?: ExportMetaData;
                                                                                                                                                                                                                                                                  realm: Record<string, RealmSkeleton>;
                                                                                                                                                                                                                                                              }
                                                                                                                                                                                                                                                              Index

                                                                                                                                                                                                                                                              Properties

                                                                                                                                                                                                                                                              Properties

                                                                                                                                                                                                                                                              realm: Record<string, RealmSkeleton>
                                                                                                                                                                                                                                                              +

                                                                                                                                                                                                                                                              Properties

                                                                                                                                                                                                                                                              realm: Record<string, RealmSkeleton>
                                                                                                                                                                                                                                                              diff --git a/docs/interfaces/Reference.ResourceTypeExportInterface.html b/docs/interfaces/Reference.ResourceTypeExportInterface.html index 4041c4275..45d100a77 100644 --- a/docs/interfaces/Reference.ResourceTypeExportInterface.html +++ b/docs/interfaces/Reference.ResourceTypeExportInterface.html @@ -1,3 +1,3 @@ -ResourceTypeExportInterface | Frodo Library - v4.0.0-10
                                                                                                                                                                                                                                                              Frodo Library - v4.0.0-10
                                                                                                                                                                                                                                                                Preparing search index...

                                                                                                                                                                                                                                                                Interface ResourceTypeExportInterface

                                                                                                                                                                                                                                                                interface ResourceTypeExportInterface {
                                                                                                                                                                                                                                                                    meta?: ExportMetaData;
                                                                                                                                                                                                                                                                    resourcetype: Record<string, ResourceTypeSkeleton>;
                                                                                                                                                                                                                                                                }
                                                                                                                                                                                                                                                                Index

                                                                                                                                                                                                                                                                Properties

                                                                                                                                                                                                                                                                meta? +ResourceTypeExportInterface | Frodo Library - v4.0.0-11
                                                                                                                                                                                                                                                                Frodo Library - v4.0.0-11
                                                                                                                                                                                                                                                                  Preparing search index...

                                                                                                                                                                                                                                                                  Interface ResourceTypeExportInterface

                                                                                                                                                                                                                                                                  interface ResourceTypeExportInterface {
                                                                                                                                                                                                                                                                      meta?: ExportMetaData;
                                                                                                                                                                                                                                                                      resourcetype: Record<string, ResourceTypeSkeleton>;
                                                                                                                                                                                                                                                                  }
                                                                                                                                                                                                                                                                  Index

                                                                                                                                                                                                                                                                  Properties

                                                                                                                                                                                                                                                                  Properties

                                                                                                                                                                                                                                                                  resourcetype: Record<string, ResourceTypeSkeleton>
                                                                                                                                                                                                                                                                  +

                                                                                                                                                                                                                                                                  Properties

                                                                                                                                                                                                                                                                  resourcetype: Record<string, ResourceTypeSkeleton>
                                                                                                                                                                                                                                                                  diff --git a/docs/interfaces/Reference.Saml2EntitiesExportOptions.html b/docs/interfaces/Reference.Saml2EntitiesExportOptions.html index 019b15e97..509f6dd2e 100644 --- a/docs/interfaces/Reference.Saml2EntitiesExportOptions.html +++ b/docs/interfaces/Reference.Saml2EntitiesExportOptions.html @@ -1,3 +1,3 @@ -Saml2EntitiesExportOptions | Frodo Library - v4.0.0-10
                                                                                                                                                                                                                                                                  Frodo Library - v4.0.0-10
                                                                                                                                                                                                                                                                    Preparing search index...

                                                                                                                                                                                                                                                                    Interface Saml2EntitiesExportOptions

                                                                                                                                                                                                                                                                    interface Saml2EntitiesExportOptions {
                                                                                                                                                                                                                                                                        deps: boolean;
                                                                                                                                                                                                                                                                    }
                                                                                                                                                                                                                                                                    Index

                                                                                                                                                                                                                                                                    Properties

                                                                                                                                                                                                                                                                    deps +Saml2EntitiesExportOptions | Frodo Library - v4.0.0-11
                                                                                                                                                                                                                                                                    Frodo Library - v4.0.0-11
                                                                                                                                                                                                                                                                      Preparing search index...

                                                                                                                                                                                                                                                                      Interface Saml2EntitiesExportOptions

                                                                                                                                                                                                                                                                      interface Saml2EntitiesExportOptions {
                                                                                                                                                                                                                                                                          deps: boolean;
                                                                                                                                                                                                                                                                      }
                                                                                                                                                                                                                                                                      Index

                                                                                                                                                                                                                                                                      Properties

                                                                                                                                                                                                                                                                      Properties

                                                                                                                                                                                                                                                                      deps: boolean

                                                                                                                                                                                                                                                                      Include any dependencies (scripts).

                                                                                                                                                                                                                                                                      -
                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                      diff --git a/docs/interfaces/Reference.Saml2EntitiesImportOptions.html b/docs/interfaces/Reference.Saml2EntitiesImportOptions.html index 06eea699f..a539feb22 100644 --- a/docs/interfaces/Reference.Saml2EntitiesImportOptions.html +++ b/docs/interfaces/Reference.Saml2EntitiesImportOptions.html @@ -1,3 +1,3 @@ -Saml2EntitiesImportOptions | Frodo Library - v4.0.0-10
                                                                                                                                                                                                                                                                      Frodo Library - v4.0.0-10
                                                                                                                                                                                                                                                                        Preparing search index...

                                                                                                                                                                                                                                                                        Interface Saml2EntitiesImportOptions

                                                                                                                                                                                                                                                                        interface Saml2EntitiesImportOptions {
                                                                                                                                                                                                                                                                            deps: boolean;
                                                                                                                                                                                                                                                                        }
                                                                                                                                                                                                                                                                        Index

                                                                                                                                                                                                                                                                        Properties

                                                                                                                                                                                                                                                                        deps +Saml2EntitiesImportOptions | Frodo Library - v4.0.0-11
                                                                                                                                                                                                                                                                        Frodo Library - v4.0.0-11
                                                                                                                                                                                                                                                                          Preparing search index...

                                                                                                                                                                                                                                                                          Interface Saml2EntitiesImportOptions

                                                                                                                                                                                                                                                                          interface Saml2EntitiesImportOptions {
                                                                                                                                                                                                                                                                              deps: boolean;
                                                                                                                                                                                                                                                                          }
                                                                                                                                                                                                                                                                          Index

                                                                                                                                                                                                                                                                          Properties

                                                                                                                                                                                                                                                                          Properties

                                                                                                                                                                                                                                                                          deps: boolean

                                                                                                                                                                                                                                                                          Include any dependencies (scripts).

                                                                                                                                                                                                                                                                          -
                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                          diff --git a/docs/interfaces/Reference.Saml2ExportInterface.html b/docs/interfaces/Reference.Saml2ExportInterface.html index 17757069c..4a631a933 100644 --- a/docs/interfaces/Reference.Saml2ExportInterface.html +++ b/docs/interfaces/Reference.Saml2ExportInterface.html @@ -1,4 +1,4 @@ -Saml2ExportInterface | Frodo Library - v4.0.0-10
                                                                                                                                                                                                                                                                          Frodo Library - v4.0.0-10
                                                                                                                                                                                                                                                                            Preparing search index...

                                                                                                                                                                                                                                                                            Interface Saml2ExportInterface

                                                                                                                                                                                                                                                                            interface Saml2ExportInterface {
                                                                                                                                                                                                                                                                                meta?: ExportMetaData;
                                                                                                                                                                                                                                                                                saml: {
                                                                                                                                                                                                                                                                                    hosted: Record<string, Saml2ProviderSkeleton>;
                                                                                                                                                                                                                                                                                    metadata: Record<string, string[]>;
                                                                                                                                                                                                                                                                                    remote: Record<string, Saml2ProviderSkeleton>;
                                                                                                                                                                                                                                                                                };
                                                                                                                                                                                                                                                                                script: Record<string, ScriptSkeleton>;
                                                                                                                                                                                                                                                                            }
                                                                                                                                                                                                                                                                            Index

                                                                                                                                                                                                                                                                            Properties

                                                                                                                                                                                                                                                                            meta? +Saml2ExportInterface | Frodo Library - v4.0.0-11
                                                                                                                                                                                                                                                                            Frodo Library - v4.0.0-11
                                                                                                                                                                                                                                                                              Preparing search index...

                                                                                                                                                                                                                                                                              Interface Saml2ExportInterface

                                                                                                                                                                                                                                                                              interface Saml2ExportInterface {
                                                                                                                                                                                                                                                                                  meta?: ExportMetaData;
                                                                                                                                                                                                                                                                                  saml: {
                                                                                                                                                                                                                                                                                      hosted: Record<string, Saml2ProviderSkeleton>;
                                                                                                                                                                                                                                                                                      metadata: Record<string, string[]>;
                                                                                                                                                                                                                                                                                      remote: Record<string, Saml2ProviderSkeleton>;
                                                                                                                                                                                                                                                                                  };
                                                                                                                                                                                                                                                                                  script: Record<string, ScriptSkeleton>;
                                                                                                                                                                                                                                                                              }
                                                                                                                                                                                                                                                                              Index

                                                                                                                                                                                                                                                                              Properties

                                                                                                                                                                                                                                                                              Properties

                                                                                                                                                                                                                                                                              saml: {
                                                                                                                                                                                                                                                                                  hosted: Record<string, Saml2ProviderSkeleton>;
                                                                                                                                                                                                                                                                                  metadata: Record<string, string[]>;
                                                                                                                                                                                                                                                                                  remote: Record<string, Saml2ProviderSkeleton>;
                                                                                                                                                                                                                                                                              }
                                                                                                                                                                                                                                                                              script: Record<string, ScriptSkeleton>
                                                                                                                                                                                                                                                                              +

                                                                                                                                                                                                                                                                              Properties

                                                                                                                                                                                                                                                                              saml: {
                                                                                                                                                                                                                                                                                  hosted: Record<string, Saml2ProviderSkeleton>;
                                                                                                                                                                                                                                                                                  metadata: Record<string, string[]>;
                                                                                                                                                                                                                                                                                  remote: Record<string, Saml2ProviderSkeleton>;
                                                                                                                                                                                                                                                                              }
                                                                                                                                                                                                                                                                              script: Record<string, ScriptSkeleton>
                                                                                                                                                                                                                                                                              diff --git a/docs/interfaces/Reference.ScriptExportInterface.html b/docs/interfaces/Reference.ScriptExportInterface.html index eadaa1614..f315d9117 100644 --- a/docs/interfaces/Reference.ScriptExportInterface.html +++ b/docs/interfaces/Reference.ScriptExportInterface.html @@ -1,3 +1,3 @@ -ScriptExportInterface | Frodo Library - v4.0.0-10
                                                                                                                                                                                                                                                                              Frodo Library - v4.0.0-10
                                                                                                                                                                                                                                                                                Preparing search index...

                                                                                                                                                                                                                                                                                Interface ScriptExportInterface

                                                                                                                                                                                                                                                                                interface ScriptExportInterface {
                                                                                                                                                                                                                                                                                    meta?: ExportMetaData;
                                                                                                                                                                                                                                                                                    script: Record<string, ScriptSkeleton>;
                                                                                                                                                                                                                                                                                }
                                                                                                                                                                                                                                                                                Index

                                                                                                                                                                                                                                                                                Properties

                                                                                                                                                                                                                                                                                meta? +ScriptExportInterface | Frodo Library - v4.0.0-11
                                                                                                                                                                                                                                                                                Frodo Library - v4.0.0-11
                                                                                                                                                                                                                                                                                  Preparing search index...

                                                                                                                                                                                                                                                                                  Interface ScriptExportInterface

                                                                                                                                                                                                                                                                                  interface ScriptExportInterface {
                                                                                                                                                                                                                                                                                      meta?: ExportMetaData;
                                                                                                                                                                                                                                                                                      script: Record<string, ScriptSkeleton>;
                                                                                                                                                                                                                                                                                  }
                                                                                                                                                                                                                                                                                  Index

                                                                                                                                                                                                                                                                                  Properties

                                                                                                                                                                                                                                                                                  Properties

                                                                                                                                                                                                                                                                                  script: Record<string, ScriptSkeleton>
                                                                                                                                                                                                                                                                                  +

                                                                                                                                                                                                                                                                                  Properties

                                                                                                                                                                                                                                                                                  script: Record<string, ScriptSkeleton>
                                                                                                                                                                                                                                                                                  diff --git a/docs/interfaces/Reference.ScriptExportOptions.html b/docs/interfaces/Reference.ScriptExportOptions.html index a30c0fb94..7bd9e6335 100644 --- a/docs/interfaces/Reference.ScriptExportOptions.html +++ b/docs/interfaces/Reference.ScriptExportOptions.html @@ -1,8 +1,8 @@ -ScriptExportOptions | Frodo Library - v4.0.0-10
                                                                                                                                                                                                                                                                                  Frodo Library - v4.0.0-10
                                                                                                                                                                                                                                                                                    Preparing search index...

                                                                                                                                                                                                                                                                                    Interface ScriptExportOptions

                                                                                                                                                                                                                                                                                    Script export options

                                                                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                                                                    interface ScriptExportOptions {
                                                                                                                                                                                                                                                                                        deps: boolean;
                                                                                                                                                                                                                                                                                        includeDefault: boolean;
                                                                                                                                                                                                                                                                                        useStringArrays: boolean;
                                                                                                                                                                                                                                                                                    }
                                                                                                                                                                                                                                                                                    Index

                                                                                                                                                                                                                                                                                    Properties

                                                                                                                                                                                                                                                                                    deps +ScriptExportOptions | Frodo Library - v4.0.0-11
                                                                                                                                                                                                                                                                                    Frodo Library - v4.0.0-11
                                                                                                                                                                                                                                                                                      Preparing search index...

                                                                                                                                                                                                                                                                                      Interface ScriptExportOptions

                                                                                                                                                                                                                                                                                      Script export options

                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                      interface ScriptExportOptions {
                                                                                                                                                                                                                                                                                          deps: boolean;
                                                                                                                                                                                                                                                                                          includeDefault: boolean;
                                                                                                                                                                                                                                                                                          useStringArrays: boolean;
                                                                                                                                                                                                                                                                                      }
                                                                                                                                                                                                                                                                                      Index

                                                                                                                                                                                                                                                                                      Properties

                                                                                                                                                                                                                                                                                      deps: boolean

                                                                                                                                                                                                                                                                                      Include dependency (library) scripts in export

                                                                                                                                                                                                                                                                                      -
                                                                                                                                                                                                                                                                                      includeDefault: boolean

                                                                                                                                                                                                                                                                                      Include default scripts in export if true

                                                                                                                                                                                                                                                                                      -
                                                                                                                                                                                                                                                                                      useStringArrays: boolean

                                                                                                                                                                                                                                                                                      Use string arrays to store script code

                                                                                                                                                                                                                                                                                      -
                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                      includeDefault: boolean

                                                                                                                                                                                                                                                                                      Include default scripts in export if true

                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                      useStringArrays: boolean

                                                                                                                                                                                                                                                                                      Use string arrays to store script code

                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                      diff --git a/docs/interfaces/Reference.ScriptImportOptions.html b/docs/interfaces/Reference.ScriptImportOptions.html index ea5629baf..e5cd0e4ef 100644 --- a/docs/interfaces/Reference.ScriptImportOptions.html +++ b/docs/interfaces/Reference.ScriptImportOptions.html @@ -1,8 +1,8 @@ -ScriptImportOptions | Frodo Library - v4.0.0-10
                                                                                                                                                                                                                                                                                      Frodo Library - v4.0.0-10
                                                                                                                                                                                                                                                                                        Preparing search index...

                                                                                                                                                                                                                                                                                        Interface ScriptImportOptions

                                                                                                                                                                                                                                                                                        Script import options

                                                                                                                                                                                                                                                                                        -
                                                                                                                                                                                                                                                                                        interface ScriptImportOptions {
                                                                                                                                                                                                                                                                                            deps: boolean;
                                                                                                                                                                                                                                                                                            includeDefault: boolean;
                                                                                                                                                                                                                                                                                            reUuid: boolean;
                                                                                                                                                                                                                                                                                        }
                                                                                                                                                                                                                                                                                        Index

                                                                                                                                                                                                                                                                                        Properties

                                                                                                                                                                                                                                                                                        deps +ScriptImportOptions | Frodo Library - v4.0.0-11
                                                                                                                                                                                                                                                                                        Frodo Library - v4.0.0-11
                                                                                                                                                                                                                                                                                          Preparing search index...

                                                                                                                                                                                                                                                                                          Interface ScriptImportOptions

                                                                                                                                                                                                                                                                                          Script import options

                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                          interface ScriptImportOptions {
                                                                                                                                                                                                                                                                                              deps: boolean;
                                                                                                                                                                                                                                                                                              includeDefault: boolean;
                                                                                                                                                                                                                                                                                              reUuid: boolean;
                                                                                                                                                                                                                                                                                          }
                                                                                                                                                                                                                                                                                          Index

                                                                                                                                                                                                                                                                                          Properties

                                                                                                                                                                                                                                                                                          deps: boolean

                                                                                                                                                                                                                                                                                          Include dependency (library) scripts in export

                                                                                                                                                                                                                                                                                          -
                                                                                                                                                                                                                                                                                          includeDefault: boolean

                                                                                                                                                                                                                                                                                          Include default scripts in import if true

                                                                                                                                                                                                                                                                                          -
                                                                                                                                                                                                                                                                                          reUuid: boolean

                                                                                                                                                                                                                                                                                          Generate new UUIDs for all scripts during import.

                                                                                                                                                                                                                                                                                          -
                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                          includeDefault: boolean

                                                                                                                                                                                                                                                                                          Include default scripts in import if true

                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                          reUuid: boolean

                                                                                                                                                                                                                                                                                          Generate new UUIDs for all scripts during import.

                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                          diff --git a/docs/interfaces/Reference.ScriptTypeExportInterface.html b/docs/interfaces/Reference.ScriptTypeExportInterface.html index 9b5aeb614..ed5e33626 100644 --- a/docs/interfaces/Reference.ScriptTypeExportInterface.html +++ b/docs/interfaces/Reference.ScriptTypeExportInterface.html @@ -1,3 +1,3 @@ -ScriptTypeExportInterface | Frodo Library - v4.0.0-10
                                                                                                                                                                                                                                                                                          Frodo Library - v4.0.0-10
                                                                                                                                                                                                                                                                                            Preparing search index...

                                                                                                                                                                                                                                                                                            Interface ScriptTypeExportInterface

                                                                                                                                                                                                                                                                                            interface ScriptTypeExportInterface {
                                                                                                                                                                                                                                                                                                meta?: ExportMetaData;
                                                                                                                                                                                                                                                                                                scripttype: Record<string, ScriptTypeExportSkeleton>;
                                                                                                                                                                                                                                                                                            }
                                                                                                                                                                                                                                                                                            Index

                                                                                                                                                                                                                                                                                            Properties

                                                                                                                                                                                                                                                                                            meta? +ScriptTypeExportInterface | Frodo Library - v4.0.0-11
                                                                                                                                                                                                                                                                                            Frodo Library - v4.0.0-11
                                                                                                                                                                                                                                                                                              Preparing search index...

                                                                                                                                                                                                                                                                                              Interface ScriptTypeExportInterface

                                                                                                                                                                                                                                                                                              interface ScriptTypeExportInterface {
                                                                                                                                                                                                                                                                                                  meta?: ExportMetaData;
                                                                                                                                                                                                                                                                                                  scripttype: Record<string, ScriptTypeExportSkeleton>;
                                                                                                                                                                                                                                                                                              }
                                                                                                                                                                                                                                                                                              Index

                                                                                                                                                                                                                                                                                              Properties

                                                                                                                                                                                                                                                                                              Properties

                                                                                                                                                                                                                                                                                              scripttype: Record<string, ScriptTypeExportSkeleton>
                                                                                                                                                                                                                                                                                              +

                                                                                                                                                                                                                                                                                              Properties

                                                                                                                                                                                                                                                                                              scripttype: Record<string, ScriptTypeExportSkeleton>
                                                                                                                                                                                                                                                                                              diff --git a/docs/interfaces/Reference.SecretStoreExportInterface.html b/docs/interfaces/Reference.SecretStoreExportInterface.html index 860e4f2b7..9baa101f4 100644 --- a/docs/interfaces/Reference.SecretStoreExportInterface.html +++ b/docs/interfaces/Reference.SecretStoreExportInterface.html @@ -1,3 +1,3 @@ -SecretStoreExportInterface | Frodo Library - v4.0.0-10
                                                                                                                                                                                                                                                                                              Frodo Library - v4.0.0-10
                                                                                                                                                                                                                                                                                                Preparing search index...

                                                                                                                                                                                                                                                                                                Interface SecretStoreExportInterface

                                                                                                                                                                                                                                                                                                interface SecretStoreExportInterface {
                                                                                                                                                                                                                                                                                                    meta?: ExportMetaData;
                                                                                                                                                                                                                                                                                                    secretstore: Record<string, SecretStoreExportSkeleton>;
                                                                                                                                                                                                                                                                                                }
                                                                                                                                                                                                                                                                                                Index

                                                                                                                                                                                                                                                                                                Properties

                                                                                                                                                                                                                                                                                                meta? +SecretStoreExportInterface | Frodo Library - v4.0.0-11
                                                                                                                                                                                                                                                                                                Frodo Library - v4.0.0-11
                                                                                                                                                                                                                                                                                                  Preparing search index...

                                                                                                                                                                                                                                                                                                  Interface SecretStoreExportInterface

                                                                                                                                                                                                                                                                                                  interface SecretStoreExportInterface {
                                                                                                                                                                                                                                                                                                      meta?: ExportMetaData;
                                                                                                                                                                                                                                                                                                      secretstore: Record<string, SecretStoreExportSkeleton>;
                                                                                                                                                                                                                                                                                                  }
                                                                                                                                                                                                                                                                                                  Index

                                                                                                                                                                                                                                                                                                  Properties

                                                                                                                                                                                                                                                                                                  Properties

                                                                                                                                                                                                                                                                                                  secretstore: Record<string, SecretStoreExportSkeleton>
                                                                                                                                                                                                                                                                                                  +

                                                                                                                                                                                                                                                                                                  Properties

                                                                                                                                                                                                                                                                                                  secretstore: Record<string, SecretStoreExportSkeleton>
                                                                                                                                                                                                                                                                                                  diff --git a/docs/interfaces/Reference.SecretsExportInterface.html b/docs/interfaces/Reference.SecretsExportInterface.html index d5d81b90b..71f4e202e 100644 --- a/docs/interfaces/Reference.SecretsExportInterface.html +++ b/docs/interfaces/Reference.SecretsExportInterface.html @@ -1,3 +1,3 @@ -SecretsExportInterface | Frodo Library - v4.0.0-10
                                                                                                                                                                                                                                                                                                  Frodo Library - v4.0.0-10
                                                                                                                                                                                                                                                                                                    Preparing search index...

                                                                                                                                                                                                                                                                                                    Interface SecretsExportInterface

                                                                                                                                                                                                                                                                                                    interface SecretsExportInterface {
                                                                                                                                                                                                                                                                                                        meta?: ExportMetaData;
                                                                                                                                                                                                                                                                                                        secret: Record<string, SecretSkeleton>;
                                                                                                                                                                                                                                                                                                    }
                                                                                                                                                                                                                                                                                                    Index

                                                                                                                                                                                                                                                                                                    Properties

                                                                                                                                                                                                                                                                                                    meta? +SecretsExportInterface | Frodo Library - v4.0.0-11
                                                                                                                                                                                                                                                                                                    Frodo Library - v4.0.0-11
                                                                                                                                                                                                                                                                                                      Preparing search index...

                                                                                                                                                                                                                                                                                                      Interface SecretsExportInterface

                                                                                                                                                                                                                                                                                                      interface SecretsExportInterface {
                                                                                                                                                                                                                                                                                                          meta?: ExportMetaData;
                                                                                                                                                                                                                                                                                                          secret: Record<string, SecretSkeleton>;
                                                                                                                                                                                                                                                                                                      }
                                                                                                                                                                                                                                                                                                      Index

                                                                                                                                                                                                                                                                                                      Properties

                                                                                                                                                                                                                                                                                                      Properties

                                                                                                                                                                                                                                                                                                      secret: Record<string, SecretSkeleton>
                                                                                                                                                                                                                                                                                                      +

                                                                                                                                                                                                                                                                                                      Properties

                                                                                                                                                                                                                                                                                                      secret: Record<string, SecretSkeleton>
                                                                                                                                                                                                                                                                                                      diff --git a/docs/interfaces/Reference.SecureConnectionProfileInterface.html b/docs/interfaces/Reference.SecureConnectionProfileInterface.html index b40f38c99..b70b7a795 100644 --- a/docs/interfaces/Reference.SecureConnectionProfileInterface.html +++ b/docs/interfaces/Reference.SecureConnectionProfileInterface.html @@ -1,4 +1,4 @@ -SecureConnectionProfileInterface | Frodo Library - v4.0.0-10
                                                                                                                                                                                                                                                                                                      Frodo Library - v4.0.0-10
                                                                                                                                                                                                                                                                                                        Preparing search index...

                                                                                                                                                                                                                                                                                                        Interface SecureConnectionProfileInterface

                                                                                                                                                                                                                                                                                                        interface SecureConnectionProfileInterface {
                                                                                                                                                                                                                                                                                                            adminClientId?: string;
                                                                                                                                                                                                                                                                                                            adminClientRedirectUri?: string;
                                                                                                                                                                                                                                                                                                            alias?: string;
                                                                                                                                                                                                                                                                                                            allowInsecureConnection?: boolean;
                                                                                                                                                                                                                                                                                                            authenticationHeaderOverrides?: Record<string, string>;
                                                                                                                                                                                                                                                                                                            authenticationService?: string;
                                                                                                                                                                                                                                                                                                            deploymentType?: string;
                                                                                                                                                                                                                                                                                                            encodedAmsterPrivateKey?: string;
                                                                                                                                                                                                                                                                                                            encodedLogApiSecret?: string;
                                                                                                                                                                                                                                                                                                            encodedPassword?: string;
                                                                                                                                                                                                                                                                                                            encodedSvcacctJwk?: string;
                                                                                                                                                                                                                                                                                                            idmHost?: string;
                                                                                                                                                                                                                                                                                                            isIGA?: boolean;
                                                                                                                                                                                                                                                                                                            logApiKey?: string;
                                                                                                                                                                                                                                                                                                            svcacctId?: string;
                                                                                                                                                                                                                                                                                                            svcacctName?: string;
                                                                                                                                                                                                                                                                                                            svcacctScope?: string;
                                                                                                                                                                                                                                                                                                            tenant: string;
                                                                                                                                                                                                                                                                                                            username?: string;
                                                                                                                                                                                                                                                                                                        }
                                                                                                                                                                                                                                                                                                        Index

                                                                                                                                                                                                                                                                                                        Properties

                                                                                                                                                                                                                                                                                                        adminClientId? +SecureConnectionProfileInterface | Frodo Library - v4.0.0-11
                                                                                                                                                                                                                                                                                                        Frodo Library - v4.0.0-11
                                                                                                                                                                                                                                                                                                          Preparing search index...

                                                                                                                                                                                                                                                                                                          Interface SecureConnectionProfileInterface

                                                                                                                                                                                                                                                                                                          interface SecureConnectionProfileInterface {
                                                                                                                                                                                                                                                                                                              adminClientId?: string;
                                                                                                                                                                                                                                                                                                              adminClientRedirectUri?: string;
                                                                                                                                                                                                                                                                                                              alias?: string;
                                                                                                                                                                                                                                                                                                              allowInsecureConnection?: boolean;
                                                                                                                                                                                                                                                                                                              authenticationHeaderOverrides?: Record<string, string>;
                                                                                                                                                                                                                                                                                                              authenticationService?: string;
                                                                                                                                                                                                                                                                                                              deploymentType?: string;
                                                                                                                                                                                                                                                                                                              encodedAmsterPrivateKey?: string;
                                                                                                                                                                                                                                                                                                              encodedLogApiSecret?: string;
                                                                                                                                                                                                                                                                                                              encodedPassword?: string;
                                                                                                                                                                                                                                                                                                              encodedSvcacctJwk?: string;
                                                                                                                                                                                                                                                                                                              idmHost?: string;
                                                                                                                                                                                                                                                                                                              isIGA?: boolean;
                                                                                                                                                                                                                                                                                                              logApiKey?: string;
                                                                                                                                                                                                                                                                                                              svcacctId?: string;
                                                                                                                                                                                                                                                                                                              svcacctName?: string;
                                                                                                                                                                                                                                                                                                              svcacctScope?: string;
                                                                                                                                                                                                                                                                                                              tenant: string;
                                                                                                                                                                                                                                                                                                              username?: string;
                                                                                                                                                                                                                                                                                                          }
                                                                                                                                                                                                                                                                                                          Index

                                                                                                                                                                                                                                                                                                          Properties

                                                                                                                                                                                                                                                                                                          adminClientId?: string
                                                                                                                                                                                                                                                                                                          adminClientRedirectUri?: string
                                                                                                                                                                                                                                                                                                          alias?: string
                                                                                                                                                                                                                                                                                                          allowInsecureConnection?: boolean
                                                                                                                                                                                                                                                                                                          authenticationHeaderOverrides?: Record<string, string>
                                                                                                                                                                                                                                                                                                          authenticationService?: string
                                                                                                                                                                                                                                                                                                          deploymentType?: string
                                                                                                                                                                                                                                                                                                          encodedAmsterPrivateKey?: string
                                                                                                                                                                                                                                                                                                          encodedLogApiSecret?: string
                                                                                                                                                                                                                                                                                                          encodedPassword?: string
                                                                                                                                                                                                                                                                                                          encodedSvcacctJwk?: string
                                                                                                                                                                                                                                                                                                          idmHost?: string
                                                                                                                                                                                                                                                                                                          isIGA?: boolean
                                                                                                                                                                                                                                                                                                          logApiKey?: string
                                                                                                                                                                                                                                                                                                          svcacctId?: string
                                                                                                                                                                                                                                                                                                          svcacctName?: string
                                                                                                                                                                                                                                                                                                          svcacctScope?: string
                                                                                                                                                                                                                                                                                                          tenant: string
                                                                                                                                                                                                                                                                                                          username?: string
                                                                                                                                                                                                                                                                                                          +

                                                                                                                                                                                                                                                                                                          Properties

                                                                                                                                                                                                                                                                                                          adminClientId?: string
                                                                                                                                                                                                                                                                                                          adminClientRedirectUri?: string
                                                                                                                                                                                                                                                                                                          alias?: string
                                                                                                                                                                                                                                                                                                          allowInsecureConnection?: boolean
                                                                                                                                                                                                                                                                                                          authenticationHeaderOverrides?: Record<string, string>
                                                                                                                                                                                                                                                                                                          authenticationService?: string
                                                                                                                                                                                                                                                                                                          deploymentType?: string
                                                                                                                                                                                                                                                                                                          encodedAmsterPrivateKey?: string
                                                                                                                                                                                                                                                                                                          encodedLogApiSecret?: string
                                                                                                                                                                                                                                                                                                          encodedPassword?: string
                                                                                                                                                                                                                                                                                                          encodedSvcacctJwk?: string
                                                                                                                                                                                                                                                                                                          idmHost?: string
                                                                                                                                                                                                                                                                                                          isIGA?: boolean
                                                                                                                                                                                                                                                                                                          logApiKey?: string
                                                                                                                                                                                                                                                                                                          svcacctId?: string
                                                                                                                                                                                                                                                                                                          svcacctName?: string
                                                                                                                                                                                                                                                                                                          svcacctScope?: string
                                                                                                                                                                                                                                                                                                          tenant: string
                                                                                                                                                                                                                                                                                                          username?: string
                                                                                                                                                                                                                                                                                                          diff --git a/docs/interfaces/Reference.ServerExportInterface.html b/docs/interfaces/Reference.ServerExportInterface.html index 9f6923ba1..555465089 100644 --- a/docs/interfaces/Reference.ServerExportInterface.html +++ b/docs/interfaces/Reference.ServerExportInterface.html @@ -1,4 +1,4 @@ -ServerExportInterface | Frodo Library - v4.0.0-10
                                                                                                                                                                                                                                                                                                          Frodo Library - v4.0.0-10
                                                                                                                                                                                                                                                                                                            Preparing search index...

                                                                                                                                                                                                                                                                                                            Interface ServerExportInterface

                                                                                                                                                                                                                                                                                                            interface ServerExportInterface {
                                                                                                                                                                                                                                                                                                                defaultProperties: ServerPropertiesSkeleton;
                                                                                                                                                                                                                                                                                                                meta?: ExportMetaData;
                                                                                                                                                                                                                                                                                                                server: Record<string, ServerExportSkeleton>;
                                                                                                                                                                                                                                                                                                            }
                                                                                                                                                                                                                                                                                                            Index

                                                                                                                                                                                                                                                                                                            Properties

                                                                                                                                                                                                                                                                                                            defaultProperties +ServerExportInterface | Frodo Library - v4.0.0-11
                                                                                                                                                                                                                                                                                                            Frodo Library - v4.0.0-11
                                                                                                                                                                                                                                                                                                              Preparing search index...

                                                                                                                                                                                                                                                                                                              Interface ServerExportInterface

                                                                                                                                                                                                                                                                                                              interface ServerExportInterface {
                                                                                                                                                                                                                                                                                                                  defaultProperties: ServerPropertiesSkeleton;
                                                                                                                                                                                                                                                                                                                  meta?: ExportMetaData;
                                                                                                                                                                                                                                                                                                                  server: Record<string, ServerExportSkeleton>;
                                                                                                                                                                                                                                                                                                              }
                                                                                                                                                                                                                                                                                                              Index

                                                                                                                                                                                                                                                                                                              Properties

                                                                                                                                                                                                                                                                                                              defaultProperties: ServerPropertiesSkeleton
                                                                                                                                                                                                                                                                                                              server: Record<string, ServerExportSkeleton>
                                                                                                                                                                                                                                                                                                              +

                                                                                                                                                                                                                                                                                                              Properties

                                                                                                                                                                                                                                                                                                              defaultProperties: ServerPropertiesSkeleton
                                                                                                                                                                                                                                                                                                              server: Record<string, ServerExportSkeleton>
                                                                                                                                                                                                                                                                                                              diff --git a/docs/interfaces/Reference.ServerExportOptions.html b/docs/interfaces/Reference.ServerExportOptions.html index 54660567e..1e98e3a2a 100644 --- a/docs/interfaces/Reference.ServerExportOptions.html +++ b/docs/interfaces/Reference.ServerExportOptions.html @@ -1,4 +1,4 @@ -ServerExportOptions | Frodo Library - v4.0.0-10
                                                                                                                                                                                                                                                                                                              Frodo Library - v4.0.0-10
                                                                                                                                                                                                                                                                                                                Preparing search index...

                                                                                                                                                                                                                                                                                                                Interface ServerExportOptions

                                                                                                                                                                                                                                                                                                                Server export options

                                                                                                                                                                                                                                                                                                                -
                                                                                                                                                                                                                                                                                                                interface ServerExportOptions {
                                                                                                                                                                                                                                                                                                                    includeDefault: boolean;
                                                                                                                                                                                                                                                                                                                }
                                                                                                                                                                                                                                                                                                                Index

                                                                                                                                                                                                                                                                                                                Properties

                                                                                                                                                                                                                                                                                                                includeDefault +ServerExportOptions | Frodo Library - v4.0.0-11
                                                                                                                                                                                                                                                                                                                Frodo Library - v4.0.0-11
                                                                                                                                                                                                                                                                                                                  Preparing search index...

                                                                                                                                                                                                                                                                                                                  Interface ServerExportOptions

                                                                                                                                                                                                                                                                                                                  Server export options

                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                  interface ServerExportOptions {
                                                                                                                                                                                                                                                                                                                      includeDefault: boolean;
                                                                                                                                                                                                                                                                                                                  }
                                                                                                                                                                                                                                                                                                                  Index

                                                                                                                                                                                                                                                                                                                  Properties

                                                                                                                                                                                                                                                                                                                  Properties

                                                                                                                                                                                                                                                                                                                  includeDefault: boolean

                                                                                                                                                                                                                                                                                                                  True to export the default server properties, false otherwise

                                                                                                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                  diff --git a/docs/interfaces/Reference.ServerImportOptions.html b/docs/interfaces/Reference.ServerImportOptions.html index 554a7e316..483f3143b 100644 --- a/docs/interfaces/Reference.ServerImportOptions.html +++ b/docs/interfaces/Reference.ServerImportOptions.html @@ -1,4 +1,4 @@ -ServerImportOptions | Frodo Library - v4.0.0-10
                                                                                                                                                                                                                                                                                                                  Frodo Library - v4.0.0-10
                                                                                                                                                                                                                                                                                                                    Preparing search index...

                                                                                                                                                                                                                                                                                                                    Interface ServerImportOptions

                                                                                                                                                                                                                                                                                                                    Server import options

                                                                                                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                                                                                                    interface ServerImportOptions {
                                                                                                                                                                                                                                                                                                                        includeDefault: boolean;
                                                                                                                                                                                                                                                                                                                    }
                                                                                                                                                                                                                                                                                                                    Index

                                                                                                                                                                                                                                                                                                                    Properties

                                                                                                                                                                                                                                                                                                                    includeDefault +ServerImportOptions | Frodo Library - v4.0.0-11
                                                                                                                                                                                                                                                                                                                    Frodo Library - v4.0.0-11
                                                                                                                                                                                                                                                                                                                      Preparing search index...

                                                                                                                                                                                                                                                                                                                      Interface ServerImportOptions

                                                                                                                                                                                                                                                                                                                      Server import options

                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                      interface ServerImportOptions {
                                                                                                                                                                                                                                                                                                                          includeDefault: boolean;
                                                                                                                                                                                                                                                                                                                      }
                                                                                                                                                                                                                                                                                                                      Index

                                                                                                                                                                                                                                                                                                                      Properties

                                                                                                                                                                                                                                                                                                                      Properties

                                                                                                                                                                                                                                                                                                                      includeDefault: boolean

                                                                                                                                                                                                                                                                                                                      True to import the default server properties, false otherwise

                                                                                                                                                                                                                                                                                                                      -
                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                      diff --git a/docs/interfaces/Reference.ServiceExportInterface.html b/docs/interfaces/Reference.ServiceExportInterface.html index 04af79c26..05de23864 100644 --- a/docs/interfaces/Reference.ServiceExportInterface.html +++ b/docs/interfaces/Reference.ServiceExportInterface.html @@ -1,3 +1,3 @@ -ServiceExportInterface | Frodo Library - v4.0.0-10
                                                                                                                                                                                                                                                                                                                      Frodo Library - v4.0.0-10
                                                                                                                                                                                                                                                                                                                        Preparing search index...

                                                                                                                                                                                                                                                                                                                        Interface ServiceExportInterface

                                                                                                                                                                                                                                                                                                                        interface ServiceExportInterface {
                                                                                                                                                                                                                                                                                                                            meta?: ExportMetaData;
                                                                                                                                                                                                                                                                                                                            service: Record<string, AmServiceSkeleton>;
                                                                                                                                                                                                                                                                                                                        }
                                                                                                                                                                                                                                                                                                                        Index

                                                                                                                                                                                                                                                                                                                        Properties

                                                                                                                                                                                                                                                                                                                        meta? +ServiceExportInterface | Frodo Library - v4.0.0-11
                                                                                                                                                                                                                                                                                                                        Frodo Library - v4.0.0-11
                                                                                                                                                                                                                                                                                                                          Preparing search index...

                                                                                                                                                                                                                                                                                                                          Interface ServiceExportInterface

                                                                                                                                                                                                                                                                                                                          interface ServiceExportInterface {
                                                                                                                                                                                                                                                                                                                              meta?: ExportMetaData;
                                                                                                                                                                                                                                                                                                                              service: Record<string, AmServiceSkeleton>;
                                                                                                                                                                                                                                                                                                                          }
                                                                                                                                                                                                                                                                                                                          Index

                                                                                                                                                                                                                                                                                                                          Properties

                                                                                                                                                                                                                                                                                                                          Properties

                                                                                                                                                                                                                                                                                                                          service: Record<string, AmServiceSkeleton>
                                                                                                                                                                                                                                                                                                                          +

                                                                                                                                                                                                                                                                                                                          Properties

                                                                                                                                                                                                                                                                                                                          service: Record<string, AmServiceSkeleton>
                                                                                                                                                                                                                                                                                                                          diff --git a/docs/interfaces/Reference.ServiceImportOptions.html b/docs/interfaces/Reference.ServiceImportOptions.html index 08c5bdfe9..eb86b0170 100644 --- a/docs/interfaces/Reference.ServiceImportOptions.html +++ b/docs/interfaces/Reference.ServiceImportOptions.html @@ -1,8 +1,8 @@ -ServiceImportOptions | Frodo Library - v4.0.0-10
                                                                                                                                                                                                                                                                                                                          Frodo Library - v4.0.0-10
                                                                                                                                                                                                                                                                                                                            Preparing search index...

                                                                                                                                                                                                                                                                                                                            Interface ServiceImportOptions

                                                                                                                                                                                                                                                                                                                            Service import options

                                                                                                                                                                                                                                                                                                                            -
                                                                                                                                                                                                                                                                                                                            interface ServiceImportOptions {
                                                                                                                                                                                                                                                                                                                                clean: boolean;
                                                                                                                                                                                                                                                                                                                                global: boolean;
                                                                                                                                                                                                                                                                                                                                realm: boolean;
                                                                                                                                                                                                                                                                                                                            }
                                                                                                                                                                                                                                                                                                                            Index

                                                                                                                                                                                                                                                                                                                            Properties

                                                                                                                                                                                                                                                                                                                            clean +ServiceImportOptions | Frodo Library - v4.0.0-11
                                                                                                                                                                                                                                                                                                                            Frodo Library - v4.0.0-11
                                                                                                                                                                                                                                                                                                                              Preparing search index...

                                                                                                                                                                                                                                                                                                                              Interface ServiceImportOptions

                                                                                                                                                                                                                                                                                                                              Service import options

                                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                                              interface ServiceImportOptions {
                                                                                                                                                                                                                                                                                                                                  clean: boolean;
                                                                                                                                                                                                                                                                                                                                  global: boolean;
                                                                                                                                                                                                                                                                                                                                  realm: boolean;
                                                                                                                                                                                                                                                                                                                              }
                                                                                                                                                                                                                                                                                                                              Index

                                                                                                                                                                                                                                                                                                                              Properties

                                                                                                                                                                                                                                                                                                                              Properties

                                                                                                                                                                                                                                                                                                                              clean: boolean

                                                                                                                                                                                                                                                                                                                              Indicates whether to remove previously existing services of the same id before importing

                                                                                                                                                                                                                                                                                                                              -
                                                                                                                                                                                                                                                                                                                              global: boolean

                                                                                                                                                                                                                                                                                                                              Indicates whether to import service(s) as global services

                                                                                                                                                                                                                                                                                                                              -
                                                                                                                                                                                                                                                                                                                              realm: boolean

                                                                                                                                                                                                                                                                                                                              Indicates whether to import service(s) to the current realm

                                                                                                                                                                                                                                                                                                                              -
                                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                                              global: boolean

                                                                                                                                                                                                                                                                                                                              Indicates whether to import service(s) as global services

                                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                                              realm: boolean

                                                                                                                                                                                                                                                                                                                              Indicates whether to import service(s) to the current realm

                                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                                              diff --git a/docs/interfaces/Reference.ServiceNextDescendent.html b/docs/interfaces/Reference.ServiceNextDescendent.html index e0ffe2c50..2181c7549 100644 --- a/docs/interfaces/Reference.ServiceNextDescendent.html +++ b/docs/interfaces/Reference.ServiceNextDescendent.html @@ -1 +1 @@ -ServiceNextDescendent | Frodo Library - v4.0.0-10
                                                                                                                                                                                                                                                                                                                              Frodo Library - v4.0.0-10
                                                                                                                                                                                                                                                                                                                                Preparing search index...

                                                                                                                                                                                                                                                                                                                                Interface ServiceNextDescendent

                                                                                                                                                                                                                                                                                                                                Indexable

                                                                                                                                                                                                                                                                                                                                • [key: string]: any
                                                                                                                                                                                                                                                                                                                                +ServiceNextDescendent | Frodo Library - v4.0.0-11
                                                                                                                                                                                                                                                                                                                                Frodo Library - v4.0.0-11
                                                                                                                                                                                                                                                                                                                                  Preparing search index...

                                                                                                                                                                                                                                                                                                                                  Interface ServiceNextDescendent

                                                                                                                                                                                                                                                                                                                                  Indexable

                                                                                                                                                                                                                                                                                                                                  • [key: string]: any
                                                                                                                                                                                                                                                                                                                                  diff --git a/docs/interfaces/Reference.SingleTreeExportInterface.html b/docs/interfaces/Reference.SingleTreeExportInterface.html index e09682257..129501427 100644 --- a/docs/interfaces/Reference.SingleTreeExportInterface.html +++ b/docs/interfaces/Reference.SingleTreeExportInterface.html @@ -1,4 +1,4 @@ -SingleTreeExportInterface | Frodo Library - v4.0.0-10
                                                                                                                                                                                                                                                                                                                                  Frodo Library - v4.0.0-10
                                                                                                                                                                                                                                                                                                                                    Preparing search index...

                                                                                                                                                                                                                                                                                                                                    Interface SingleTreeExportInterface

                                                                                                                                                                                                                                                                                                                                    interface SingleTreeExportInterface {
                                                                                                                                                                                                                                                                                                                                        circlesOfTrust: Record<string, CircleOfTrustSkeleton>;
                                                                                                                                                                                                                                                                                                                                        emailTemplates: Record<string, EmailTemplateSkeleton>;
                                                                                                                                                                                                                                                                                                                                        innernodes?: Record<string, NodeSkeleton>;
                                                                                                                                                                                                                                                                                                                                        innerNodes?: Record<string, NodeSkeleton>;
                                                                                                                                                                                                                                                                                                                                        meta?: ExportMetaData;
                                                                                                                                                                                                                                                                                                                                        nodes: Record<string, NodeSkeleton>;
                                                                                                                                                                                                                                                                                                                                        nodeTypes?: Record<string, CustomNodeSkeleton>;
                                                                                                                                                                                                                                                                                                                                        saml2Entities: Record<string, Saml2ProviderSkeleton>;
                                                                                                                                                                                                                                                                                                                                        scripts: Record<string, ScriptSkeleton>;
                                                                                                                                                                                                                                                                                                                                        socialIdentityProviders: Record<string, SocialIdpSkeleton>;
                                                                                                                                                                                                                                                                                                                                        themes: ThemeSkeleton[];
                                                                                                                                                                                                                                                                                                                                        tree: TreeSkeleton;
                                                                                                                                                                                                                                                                                                                                        variable: Record<string, VariableSkeleton>;
                                                                                                                                                                                                                                                                                                                                    }
                                                                                                                                                                                                                                                                                                                                    Index

                                                                                                                                                                                                                                                                                                                                    Properties

                                                                                                                                                                                                                                                                                                                                    circlesOfTrust +SingleTreeExportInterface | Frodo Library - v4.0.0-11
                                                                                                                                                                                                                                                                                                                                    Frodo Library - v4.0.0-11
                                                                                                                                                                                                                                                                                                                                      Preparing search index...

                                                                                                                                                                                                                                                                                                                                      Interface SingleTreeExportInterface

                                                                                                                                                                                                                                                                                                                                      interface SingleTreeExportInterface {
                                                                                                                                                                                                                                                                                                                                          circlesOfTrust: Record<string, CircleOfTrustSkeleton>;
                                                                                                                                                                                                                                                                                                                                          emailTemplates: Record<string, EmailTemplateSkeleton>;
                                                                                                                                                                                                                                                                                                                                          innernodes?: Record<string, NodeSkeleton>;
                                                                                                                                                                                                                                                                                                                                          innerNodes?: Record<string, NodeSkeleton>;
                                                                                                                                                                                                                                                                                                                                          meta?: ExportMetaData;
                                                                                                                                                                                                                                                                                                                                          nodes: Record<string, NodeSkeleton>;
                                                                                                                                                                                                                                                                                                                                          nodeTypes?: Record<string, CustomNodeSkeleton>;
                                                                                                                                                                                                                                                                                                                                          saml2Entities: Record<string, Saml2ProviderSkeleton>;
                                                                                                                                                                                                                                                                                                                                          scripts: Record<string, ScriptSkeleton>;
                                                                                                                                                                                                                                                                                                                                          socialIdentityProviders: Record<string, SocialIdpSkeleton>;
                                                                                                                                                                                                                                                                                                                                          themes: ThemeSkeleton[];
                                                                                                                                                                                                                                                                                                                                          tree: TreeSkeleton;
                                                                                                                                                                                                                                                                                                                                          variable: Record<string, VariableSkeleton>;
                                                                                                                                                                                                                                                                                                                                      }
                                                                                                                                                                                                                                                                                                                                      Index

                                                                                                                                                                                                                                                                                                                                      Properties

                                                                                                                                                                                                                                                                                                                                      circlesOfTrust: Record<string, CircleOfTrustSkeleton>
                                                                                                                                                                                                                                                                                                                                      emailTemplates: Record<string, EmailTemplateSkeleton>
                                                                                                                                                                                                                                                                                                                                      innernodes?: Record<string, NodeSkeleton>
                                                                                                                                                                                                                                                                                                                                      innerNodes?: Record<string, NodeSkeleton>
                                                                                                                                                                                                                                                                                                                                      nodes: Record<string, NodeSkeleton>
                                                                                                                                                                                                                                                                                                                                      nodeTypes?: Record<string, CustomNodeSkeleton>
                                                                                                                                                                                                                                                                                                                                      saml2Entities: Record<string, Saml2ProviderSkeleton>
                                                                                                                                                                                                                                                                                                                                      scripts: Record<string, ScriptSkeleton>
                                                                                                                                                                                                                                                                                                                                      socialIdentityProviders: Record<string, SocialIdpSkeleton>
                                                                                                                                                                                                                                                                                                                                      themes: ThemeSkeleton[]
                                                                                                                                                                                                                                                                                                                                      variable: Record<string, VariableSkeleton>
                                                                                                                                                                                                                                                                                                                                      +

                                                                                                                                                                                                                                                                                                                                      Properties

                                                                                                                                                                                                                                                                                                                                      circlesOfTrust: Record<string, CircleOfTrustSkeleton>
                                                                                                                                                                                                                                                                                                                                      emailTemplates: Record<string, EmailTemplateSkeleton>
                                                                                                                                                                                                                                                                                                                                      innernodes?: Record<string, NodeSkeleton>
                                                                                                                                                                                                                                                                                                                                      innerNodes?: Record<string, NodeSkeleton>
                                                                                                                                                                                                                                                                                                                                      nodes: Record<string, NodeSkeleton>
                                                                                                                                                                                                                                                                                                                                      nodeTypes?: Record<string, CustomNodeSkeleton>
                                                                                                                                                                                                                                                                                                                                      saml2Entities: Record<string, Saml2ProviderSkeleton>
                                                                                                                                                                                                                                                                                                                                      scripts: Record<string, ScriptSkeleton>
                                                                                                                                                                                                                                                                                                                                      socialIdentityProviders: Record<string, SocialIdpSkeleton>
                                                                                                                                                                                                                                                                                                                                      themes: ThemeSkeleton[]
                                                                                                                                                                                                                                                                                                                                      variable: Record<string, VariableSkeleton>
                                                                                                                                                                                                                                                                                                                                      diff --git a/docs/interfaces/Reference.SiteExportInterface.html b/docs/interfaces/Reference.SiteExportInterface.html index 99ea7bd01..41ea8f33d 100644 --- a/docs/interfaces/Reference.SiteExportInterface.html +++ b/docs/interfaces/Reference.SiteExportInterface.html @@ -1,3 +1,3 @@ -SiteExportInterface | Frodo Library - v4.0.0-10
                                                                                                                                                                                                                                                                                                                                      Frodo Library - v4.0.0-10
                                                                                                                                                                                                                                                                                                                                        Preparing search index...

                                                                                                                                                                                                                                                                                                                                        Interface SiteExportInterface

                                                                                                                                                                                                                                                                                                                                        interface SiteExportInterface {
                                                                                                                                                                                                                                                                                                                                            meta?: ExportMetaData;
                                                                                                                                                                                                                                                                                                                                            site: Record<string, SiteSkeleton>;
                                                                                                                                                                                                                                                                                                                                        }
                                                                                                                                                                                                                                                                                                                                        Index

                                                                                                                                                                                                                                                                                                                                        Properties

                                                                                                                                                                                                                                                                                                                                        meta? +SiteExportInterface | Frodo Library - v4.0.0-11
                                                                                                                                                                                                                                                                                                                                        Frodo Library - v4.0.0-11
                                                                                                                                                                                                                                                                                                                                          Preparing search index...

                                                                                                                                                                                                                                                                                                                                          Interface SiteExportInterface

                                                                                                                                                                                                                                                                                                                                          interface SiteExportInterface {
                                                                                                                                                                                                                                                                                                                                              meta?: ExportMetaData;
                                                                                                                                                                                                                                                                                                                                              site: Record<string, SiteSkeleton>;
                                                                                                                                                                                                                                                                                                                                          }
                                                                                                                                                                                                                                                                                                                                          Index

                                                                                                                                                                                                                                                                                                                                          Properties

                                                                                                                                                                                                                                                                                                                                          Properties

                                                                                                                                                                                                                                                                                                                                          site: Record<string, SiteSkeleton>
                                                                                                                                                                                                                                                                                                                                          +

                                                                                                                                                                                                                                                                                                                                          Properties

                                                                                                                                                                                                                                                                                                                                          site: Record<string, SiteSkeleton>
                                                                                                                                                                                                                                                                                                                                          diff --git a/docs/interfaces/Reference.SocialIdentityProviderExportOptions.html b/docs/interfaces/Reference.SocialIdentityProviderExportOptions.html index ee339440a..e0ebf1b31 100644 --- a/docs/interfaces/Reference.SocialIdentityProviderExportOptions.html +++ b/docs/interfaces/Reference.SocialIdentityProviderExportOptions.html @@ -1,6 +1,6 @@ -SocialIdentityProviderExportOptions | Frodo Library - v4.0.0-10
                                                                                                                                                                                                                                                                                                                                          Frodo Library - v4.0.0-10
                                                                                                                                                                                                                                                                                                                                            Preparing search index...

                                                                                                                                                                                                                                                                                                                                            Interface SocialIdentityProviderExportOptions

                                                                                                                                                                                                                                                                                                                                            Social identity provider export options

                                                                                                                                                                                                                                                                                                                                            -
                                                                                                                                                                                                                                                                                                                                            interface SocialIdentityProviderExportOptions {
                                                                                                                                                                                                                                                                                                                                                deps: boolean;
                                                                                                                                                                                                                                                                                                                                                useStringArrays: boolean;
                                                                                                                                                                                                                                                                                                                                            }
                                                                                                                                                                                                                                                                                                                                            Index

                                                                                                                                                                                                                                                                                                                                            Properties

                                                                                                                                                                                                                                                                                                                                            deps +SocialIdentityProviderExportOptions | Frodo Library - v4.0.0-11
                                                                                                                                                                                                                                                                                                                                            Frodo Library - v4.0.0-11
                                                                                                                                                                                                                                                                                                                                              Preparing search index...

                                                                                                                                                                                                                                                                                                                                              Interface SocialIdentityProviderExportOptions

                                                                                                                                                                                                                                                                                                                                              Social identity provider export options

                                                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                                                              interface SocialIdentityProviderExportOptions {
                                                                                                                                                                                                                                                                                                                                                  deps: boolean;
                                                                                                                                                                                                                                                                                                                                                  useStringArrays: boolean;
                                                                                                                                                                                                                                                                                                                                              }
                                                                                                                                                                                                                                                                                                                                              Index

                                                                                                                                                                                                                                                                                                                                              Properties

                                                                                                                                                                                                                                                                                                                                              deps: boolean

                                                                                                                                                                                                                                                                                                                                              Include any dependencies (scripts).

                                                                                                                                                                                                                                                                                                                                              -
                                                                                                                                                                                                                                                                                                                                              useStringArrays: boolean

                                                                                                                                                                                                                                                                                                                                              Use string arrays to store multi-line text in scripts.

                                                                                                                                                                                                                                                                                                                                              -
                                                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                                                              useStringArrays: boolean

                                                                                                                                                                                                                                                                                                                                              Use string arrays to store multi-line text in scripts.

                                                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                                                              diff --git a/docs/interfaces/Reference.SocialIdentityProviderImportOptions.html b/docs/interfaces/Reference.SocialIdentityProviderImportOptions.html index b237699de..960e55e7d 100644 --- a/docs/interfaces/Reference.SocialIdentityProviderImportOptions.html +++ b/docs/interfaces/Reference.SocialIdentityProviderImportOptions.html @@ -1,4 +1,4 @@ -SocialIdentityProviderImportOptions | Frodo Library - v4.0.0-10
                                                                                                                                                                                                                                                                                                                                              Frodo Library - v4.0.0-10
                                                                                                                                                                                                                                                                                                                                                Preparing search index...

                                                                                                                                                                                                                                                                                                                                                Interface SocialIdentityProviderImportOptions

                                                                                                                                                                                                                                                                                                                                                Social identity provider import options

                                                                                                                                                                                                                                                                                                                                                -
                                                                                                                                                                                                                                                                                                                                                interface SocialIdentityProviderImportOptions {
                                                                                                                                                                                                                                                                                                                                                    deps: boolean;
                                                                                                                                                                                                                                                                                                                                                }
                                                                                                                                                                                                                                                                                                                                                Index

                                                                                                                                                                                                                                                                                                                                                Properties

                                                                                                                                                                                                                                                                                                                                                deps +SocialIdentityProviderImportOptions | Frodo Library - v4.0.0-11
                                                                                                                                                                                                                                                                                                                                                Frodo Library - v4.0.0-11
                                                                                                                                                                                                                                                                                                                                                  Preparing search index...

                                                                                                                                                                                                                                                                                                                                                  Interface SocialIdentityProviderImportOptions

                                                                                                                                                                                                                                                                                                                                                  Social identity provider import options

                                                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                                                  interface SocialIdentityProviderImportOptions {
                                                                                                                                                                                                                                                                                                                                                      deps: boolean;
                                                                                                                                                                                                                                                                                                                                                  }
                                                                                                                                                                                                                                                                                                                                                  Index

                                                                                                                                                                                                                                                                                                                                                  Properties

                                                                                                                                                                                                                                                                                                                                                  Properties

                                                                                                                                                                                                                                                                                                                                                  deps: boolean

                                                                                                                                                                                                                                                                                                                                                  Include any dependencies (scripts).

                                                                                                                                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                                                  diff --git a/docs/interfaces/Reference.SocialProviderExportInterface.html b/docs/interfaces/Reference.SocialProviderExportInterface.html index 452d4ab29..af88e3b68 100644 --- a/docs/interfaces/Reference.SocialProviderExportInterface.html +++ b/docs/interfaces/Reference.SocialProviderExportInterface.html @@ -1,4 +1,4 @@ -SocialProviderExportInterface | Frodo Library - v4.0.0-10
                                                                                                                                                                                                                                                                                                                                                  Frodo Library - v4.0.0-10
                                                                                                                                                                                                                                                                                                                                                    Preparing search index...

                                                                                                                                                                                                                                                                                                                                                    Interface SocialProviderExportInterface

                                                                                                                                                                                                                                                                                                                                                    interface SocialProviderExportInterface {
                                                                                                                                                                                                                                                                                                                                                        idp: Record<string, SocialIdpSkeleton>;
                                                                                                                                                                                                                                                                                                                                                        meta?: ExportMetaData;
                                                                                                                                                                                                                                                                                                                                                        script: Record<string, ScriptSkeleton>;
                                                                                                                                                                                                                                                                                                                                                    }
                                                                                                                                                                                                                                                                                                                                                    Index

                                                                                                                                                                                                                                                                                                                                                    Properties

                                                                                                                                                                                                                                                                                                                                                    idp +SocialProviderExportInterface | Frodo Library - v4.0.0-11
                                                                                                                                                                                                                                                                                                                                                    Frodo Library - v4.0.0-11
                                                                                                                                                                                                                                                                                                                                                      Preparing search index...

                                                                                                                                                                                                                                                                                                                                                      Interface SocialProviderExportInterface

                                                                                                                                                                                                                                                                                                                                                      interface SocialProviderExportInterface {
                                                                                                                                                                                                                                                                                                                                                          idp: Record<string, SocialIdpSkeleton>;
                                                                                                                                                                                                                                                                                                                                                          meta?: ExportMetaData;
                                                                                                                                                                                                                                                                                                                                                          script: Record<string, ScriptSkeleton>;
                                                                                                                                                                                                                                                                                                                                                      }
                                                                                                                                                                                                                                                                                                                                                      Index

                                                                                                                                                                                                                                                                                                                                                      Properties

                                                                                                                                                                                                                                                                                                                                                      Properties

                                                                                                                                                                                                                                                                                                                                                      idp: Record<string, SocialIdpSkeleton>
                                                                                                                                                                                                                                                                                                                                                      script: Record<string, ScriptSkeleton>
                                                                                                                                                                                                                                                                                                                                                      +

                                                                                                                                                                                                                                                                                                                                                      Properties

                                                                                                                                                                                                                                                                                                                                                      idp: Record<string, SocialIdpSkeleton>
                                                                                                                                                                                                                                                                                                                                                      script: Record<string, ScriptSkeleton>
                                                                                                                                                                                                                                                                                                                                                      diff --git a/docs/interfaces/Reference.StateInterface.html b/docs/interfaces/Reference.StateInterface.html index a5f7abec3..31b7d324f 100644 --- a/docs/interfaces/Reference.StateInterface.html +++ b/docs/interfaces/Reference.StateInterface.html @@ -1,4 +1,4 @@ -StateInterface | Frodo Library - v4.0.0-10
                                                                                                                                                                                                                                                                                                                                                      Frodo Library - v4.0.0-10
                                                                                                                                                                                                                                                                                                                                                        Preparing search index...

                                                                                                                                                                                                                                                                                                                                                        Interface StateInterface

                                                                                                                                                                                                                                                                                                                                                        interface StateInterface {
                                                                                                                                                                                                                                                                                                                                                            adminClientId?: string;
                                                                                                                                                                                                                                                                                                                                                            adminClientRedirectUri?: string;
                                                                                                                                                                                                                                                                                                                                                            alias?: string;
                                                                                                                                                                                                                                                                                                                                                            allowInsecureConnection?: boolean;
                                                                                                                                                                                                                                                                                                                                                            amsterPrivateKey?: string;
                                                                                                                                                                                                                                                                                                                                                            amVersion?: string;
                                                                                                                                                                                                                                                                                                                                                            authenticationHeaderOverrides?: Record<string, string>;
                                                                                                                                                                                                                                                                                                                                                            authenticationService?: string;
                                                                                                                                                                                                                                                                                                                                                            autoRefreshTimer?: Timeout;
                                                                                                                                                                                                                                                                                                                                                            axiosRetryConfig?: IAxiosRetryConfig;
                                                                                                                                                                                                                                                                                                                                                            bearerToken?: AccessTokenMetaType;
                                                                                                                                                                                                                                                                                                                                                            connectionProfilesPath?: string;
                                                                                                                                                                                                                                                                                                                                                            cookieName?: string;
                                                                                                                                                                                                                                                                                                                                                            createProgressHandler?: (
                                                                                                                                                                                                                                                                                                                                                                type: ProgressIndicatorType,
                                                                                                                                                                                                                                                                                                                                                                total?: number,
                                                                                                                                                                                                                                                                                                                                                                message?: string,
                                                                                                                                                                                                                                                                                                                                                            ) => string;
                                                                                                                                                                                                                                                                                                                                                            curlirize?: boolean;
                                                                                                                                                                                                                                                                                                                                                            curlirizeHandler?: (message: string) => void;
                                                                                                                                                                                                                                                                                                                                                            debug?: boolean;
                                                                                                                                                                                                                                                                                                                                                            debugHandler?: (message: string | object) => void;
                                                                                                                                                                                                                                                                                                                                                            deploymentType?: string;
                                                                                                                                                                                                                                                                                                                                                            directory?: string;
                                                                                                                                                                                                                                                                                                                                                            errorHandler?: (error: Error, message: string) => void;
                                                                                                                                                                                                                                                                                                                                                            features?: FeatureInterface[];
                                                                                                                                                                                                                                                                                                                                                            frodoVersion?: string;
                                                                                                                                                                                                                                                                                                                                                            host?: string;
                                                                                                                                                                                                                                                                                                                                                            idmHost?: string;
                                                                                                                                                                                                                                                                                                                                                            isIGA?: boolean;
                                                                                                                                                                                                                                                                                                                                                            logApiKey?: string;
                                                                                                                                                                                                                                                                                                                                                            logApiSecret?: string;
                                                                                                                                                                                                                                                                                                                                                            masterKeyPath?: string;
                                                                                                                                                                                                                                                                                                                                                            outputFile?: string;
                                                                                                                                                                                                                                                                                                                                                            password?: string;
                                                                                                                                                                                                                                                                                                                                                            printHandler?: (
                                                                                                                                                                                                                                                                                                                                                                message: string | object,
                                                                                                                                                                                                                                                                                                                                                                type?: string,
                                                                                                                                                                                                                                                                                                                                                                newline?: boolean,
                                                                                                                                                                                                                                                                                                                                                            ) => void;
                                                                                                                                                                                                                                                                                                                                                            realm?: string;
                                                                                                                                                                                                                                                                                                                                                            serviceAccountId?: string;
                                                                                                                                                                                                                                                                                                                                                            serviceAccountJwk?: JwkRsa;
                                                                                                                                                                                                                                                                                                                                                            serviceAccountScope?: string;
                                                                                                                                                                                                                                                                                                                                                            stopProgressHandler?: (
                                                                                                                                                                                                                                                                                                                                                                id: string,
                                                                                                                                                                                                                                                                                                                                                                message: string,
                                                                                                                                                                                                                                                                                                                                                                status?: string,
                                                                                                                                                                                                                                                                                                                                                            ) => void;
                                                                                                                                                                                                                                                                                                                                                            tokenCachePath?: string;
                                                                                                                                                                                                                                                                                                                                                            updateProgressHandler?: (id: string, message: string) => void;
                                                                                                                                                                                                                                                                                                                                                            useBearerTokenForAmApis?: boolean;
                                                                                                                                                                                                                                                                                                                                                            useRealmPrefixOnManagedObjects?: boolean;
                                                                                                                                                                                                                                                                                                                                                            username?: string;
                                                                                                                                                                                                                                                                                                                                                            userSessionToken?: UserSessionMetaType;
                                                                                                                                                                                                                                                                                                                                                            useTokenCache?: boolean;
                                                                                                                                                                                                                                                                                                                                                            verbose?: boolean;
                                                                                                                                                                                                                                                                                                                                                            verboseHandler?: (message: string | object) => void;
                                                                                                                                                                                                                                                                                                                                                        }
                                                                                                                                                                                                                                                                                                                                                        Index

                                                                                                                                                                                                                                                                                                                                                        Properties

                                                                                                                                                                                                                                                                                                                                                        adminClientId? +StateInterface | Frodo Library - v4.0.0-11
                                                                                                                                                                                                                                                                                                                                                        Frodo Library - v4.0.0-11
                                                                                                                                                                                                                                                                                                                                                          Preparing search index...

                                                                                                                                                                                                                                                                                                                                                          Interface StateInterface

                                                                                                                                                                                                                                                                                                                                                          interface StateInterface {
                                                                                                                                                                                                                                                                                                                                                              adminClientId?: string;
                                                                                                                                                                                                                                                                                                                                                              adminClientRedirectUri?: string;
                                                                                                                                                                                                                                                                                                                                                              alias?: string;
                                                                                                                                                                                                                                                                                                                                                              allowInsecureConnection?: boolean;
                                                                                                                                                                                                                                                                                                                                                              amsterPrivateKey?: string;
                                                                                                                                                                                                                                                                                                                                                              amVersion?: string;
                                                                                                                                                                                                                                                                                                                                                              authenticationHeaderOverrides?: Record<string, string>;
                                                                                                                                                                                                                                                                                                                                                              authenticationService?: string;
                                                                                                                                                                                                                                                                                                                                                              autoRefreshTimer?: Timeout;
                                                                                                                                                                                                                                                                                                                                                              axiosRetryConfig?: IAxiosRetryConfig;
                                                                                                                                                                                                                                                                                                                                                              bearerToken?: AccessTokenMetaType;
                                                                                                                                                                                                                                                                                                                                                              connectionProfilesPath?: string;
                                                                                                                                                                                                                                                                                                                                                              cookieName?: string;
                                                                                                                                                                                                                                                                                                                                                              createProgressHandler?: (
                                                                                                                                                                                                                                                                                                                                                                  type: ProgressIndicatorType,
                                                                                                                                                                                                                                                                                                                                                                  total?: number,
                                                                                                                                                                                                                                                                                                                                                                  message?: string,
                                                                                                                                                                                                                                                                                                                                                              ) => string;
                                                                                                                                                                                                                                                                                                                                                              curlirize?: boolean;
                                                                                                                                                                                                                                                                                                                                                              curlirizeHandler?: (message: string) => void;
                                                                                                                                                                                                                                                                                                                                                              debug?: boolean;
                                                                                                                                                                                                                                                                                                                                                              debugHandler?: (message: string | object) => void;
                                                                                                                                                                                                                                                                                                                                                              deploymentType?: string;
                                                                                                                                                                                                                                                                                                                                                              directory?: string;
                                                                                                                                                                                                                                                                                                                                                              errorHandler?: (error: Error, message: string) => void;
                                                                                                                                                                                                                                                                                                                                                              features?: FeatureInterface[];
                                                                                                                                                                                                                                                                                                                                                              frodoVersion?: string;
                                                                                                                                                                                                                                                                                                                                                              host?: string;
                                                                                                                                                                                                                                                                                                                                                              idmHost?: string;
                                                                                                                                                                                                                                                                                                                                                              isIGA?: boolean;
                                                                                                                                                                                                                                                                                                                                                              logApiKey?: string;
                                                                                                                                                                                                                                                                                                                                                              logApiSecret?: string;
                                                                                                                                                                                                                                                                                                                                                              masterKeyPath?: string;
                                                                                                                                                                                                                                                                                                                                                              outputFile?: string;
                                                                                                                                                                                                                                                                                                                                                              password?: string;
                                                                                                                                                                                                                                                                                                                                                              printHandler?: (
                                                                                                                                                                                                                                                                                                                                                                  message: string | object,
                                                                                                                                                                                                                                                                                                                                                                  type?: string,
                                                                                                                                                                                                                                                                                                                                                                  newline?: boolean,
                                                                                                                                                                                                                                                                                                                                                              ) => void;
                                                                                                                                                                                                                                                                                                                                                              realm?: string;
                                                                                                                                                                                                                                                                                                                                                              serviceAccountId?: string;
                                                                                                                                                                                                                                                                                                                                                              serviceAccountJwk?: JwkRsa;
                                                                                                                                                                                                                                                                                                                                                              serviceAccountScope?: string;
                                                                                                                                                                                                                                                                                                                                                              stopProgressHandler?: (
                                                                                                                                                                                                                                                                                                                                                                  id: string,
                                                                                                                                                                                                                                                                                                                                                                  message: string,
                                                                                                                                                                                                                                                                                                                                                                  status?: string,
                                                                                                                                                                                                                                                                                                                                                              ) => void;
                                                                                                                                                                                                                                                                                                                                                              tokenCachePath?: string;
                                                                                                                                                                                                                                                                                                                                                              updateProgressHandler?: (id: string, message: string) => void;
                                                                                                                                                                                                                                                                                                                                                              useBearerTokenForAmApis?: boolean;
                                                                                                                                                                                                                                                                                                                                                              useRealmPrefixOnManagedObjects?: boolean;
                                                                                                                                                                                                                                                                                                                                                              username?: string;
                                                                                                                                                                                                                                                                                                                                                              userSessionToken?: UserSessionMetaType;
                                                                                                                                                                                                                                                                                                                                                              useTokenCache?: boolean;
                                                                                                                                                                                                                                                                                                                                                              verbose?: boolean;
                                                                                                                                                                                                                                                                                                                                                              verboseHandler?: (message: string | object) => void;
                                                                                                                                                                                                                                                                                                                                                          }
                                                                                                                                                                                                                                                                                                                                                          Index

                                                                                                                                                                                                                                                                                                                                                          Properties

                                                                                                                                                                                                                                                                                                                                                          adminClientId?: string
                                                                                                                                                                                                                                                                                                                                                          adminClientRedirectUri?: string
                                                                                                                                                                                                                                                                                                                                                          alias?: string
                                                                                                                                                                                                                                                                                                                                                          allowInsecureConnection?: boolean
                                                                                                                                                                                                                                                                                                                                                          amsterPrivateKey?: string
                                                                                                                                                                                                                                                                                                                                                          amVersion?: string
                                                                                                                                                                                                                                                                                                                                                          authenticationHeaderOverrides?: Record<string, string>
                                                                                                                                                                                                                                                                                                                                                          authenticationService?: string
                                                                                                                                                                                                                                                                                                                                                          autoRefreshTimer?: Timeout
                                                                                                                                                                                                                                                                                                                                                          axiosRetryConfig?: IAxiosRetryConfig
                                                                                                                                                                                                                                                                                                                                                          bearerToken?: AccessTokenMetaType
                                                                                                                                                                                                                                                                                                                                                          connectionProfilesPath?: string
                                                                                                                                                                                                                                                                                                                                                          cookieName?: string
                                                                                                                                                                                                                                                                                                                                                          createProgressHandler?: (
                                                                                                                                                                                                                                                                                                                                                              type: ProgressIndicatorType,
                                                                                                                                                                                                                                                                                                                                                              total?: number,
                                                                                                                                                                                                                                                                                                                                                              message?: string,
                                                                                                                                                                                                                                                                                                                                                          ) => string
                                                                                                                                                                                                                                                                                                                                                          curlirize?: boolean
                                                                                                                                                                                                                                                                                                                                                          curlirizeHandler?: (message: string) => void
                                                                                                                                                                                                                                                                                                                                                          debug?: boolean
                                                                                                                                                                                                                                                                                                                                                          debugHandler?: (message: string | object) => void
                                                                                                                                                                                                                                                                                                                                                          deploymentType?: string
                                                                                                                                                                                                                                                                                                                                                          directory?: string
                                                                                                                                                                                                                                                                                                                                                          errorHandler?: (error: Error, message: string) => void
                                                                                                                                                                                                                                                                                                                                                          features?: FeatureInterface[]
                                                                                                                                                                                                                                                                                                                                                          frodoVersion?: string
                                                                                                                                                                                                                                                                                                                                                          host?: string
                                                                                                                                                                                                                                                                                                                                                          idmHost?: string
                                                                                                                                                                                                                                                                                                                                                          isIGA?: boolean
                                                                                                                                                                                                                                                                                                                                                          logApiKey?: string
                                                                                                                                                                                                                                                                                                                                                          logApiSecret?: string
                                                                                                                                                                                                                                                                                                                                                          masterKeyPath?: string
                                                                                                                                                                                                                                                                                                                                                          outputFile?: string
                                                                                                                                                                                                                                                                                                                                                          password?: string
                                                                                                                                                                                                                                                                                                                                                          printHandler?: (
                                                                                                                                                                                                                                                                                                                                                              message: string | object,
                                                                                                                                                                                                                                                                                                                                                              type?: string,
                                                                                                                                                                                                                                                                                                                                                              newline?: boolean,
                                                                                                                                                                                                                                                                                                                                                          ) => void
                                                                                                                                                                                                                                                                                                                                                          realm?: string
                                                                                                                                                                                                                                                                                                                                                          serviceAccountId?: string
                                                                                                                                                                                                                                                                                                                                                          serviceAccountJwk?: JwkRsa
                                                                                                                                                                                                                                                                                                                                                          serviceAccountScope?: string
                                                                                                                                                                                                                                                                                                                                                          stopProgressHandler?: (id: string, message: string, status?: string) => void
                                                                                                                                                                                                                                                                                                                                                          tokenCachePath?: string
                                                                                                                                                                                                                                                                                                                                                          updateProgressHandler?: (id: string, message: string) => void
                                                                                                                                                                                                                                                                                                                                                          useBearerTokenForAmApis?: boolean
                                                                                                                                                                                                                                                                                                                                                          useRealmPrefixOnManagedObjects?: boolean
                                                                                                                                                                                                                                                                                                                                                          username?: string
                                                                                                                                                                                                                                                                                                                                                          userSessionToken?: UserSessionMetaType
                                                                                                                                                                                                                                                                                                                                                          useTokenCache?: boolean
                                                                                                                                                                                                                                                                                                                                                          verbose?: boolean
                                                                                                                                                                                                                                                                                                                                                          verboseHandler?: (message: string | object) => void
                                                                                                                                                                                                                                                                                                                                                          +

                                                                                                                                                                                                                                                                                                                                                          Properties

                                                                                                                                                                                                                                                                                                                                                          adminClientId?: string
                                                                                                                                                                                                                                                                                                                                                          adminClientRedirectUri?: string
                                                                                                                                                                                                                                                                                                                                                          alias?: string
                                                                                                                                                                                                                                                                                                                                                          allowInsecureConnection?: boolean
                                                                                                                                                                                                                                                                                                                                                          amsterPrivateKey?: string
                                                                                                                                                                                                                                                                                                                                                          amVersion?: string
                                                                                                                                                                                                                                                                                                                                                          authenticationHeaderOverrides?: Record<string, string>
                                                                                                                                                                                                                                                                                                                                                          authenticationService?: string
                                                                                                                                                                                                                                                                                                                                                          autoRefreshTimer?: Timeout
                                                                                                                                                                                                                                                                                                                                                          axiosRetryConfig?: IAxiosRetryConfig
                                                                                                                                                                                                                                                                                                                                                          bearerToken?: AccessTokenMetaType
                                                                                                                                                                                                                                                                                                                                                          connectionProfilesPath?: string
                                                                                                                                                                                                                                                                                                                                                          cookieName?: string
                                                                                                                                                                                                                                                                                                                                                          createProgressHandler?: (
                                                                                                                                                                                                                                                                                                                                                              type: ProgressIndicatorType,
                                                                                                                                                                                                                                                                                                                                                              total?: number,
                                                                                                                                                                                                                                                                                                                                                              message?: string,
                                                                                                                                                                                                                                                                                                                                                          ) => string
                                                                                                                                                                                                                                                                                                                                                          curlirize?: boolean
                                                                                                                                                                                                                                                                                                                                                          curlirizeHandler?: (message: string) => void
                                                                                                                                                                                                                                                                                                                                                          debug?: boolean
                                                                                                                                                                                                                                                                                                                                                          debugHandler?: (message: string | object) => void
                                                                                                                                                                                                                                                                                                                                                          deploymentType?: string
                                                                                                                                                                                                                                                                                                                                                          directory?: string
                                                                                                                                                                                                                                                                                                                                                          errorHandler?: (error: Error, message: string) => void
                                                                                                                                                                                                                                                                                                                                                          features?: FeatureInterface[]
                                                                                                                                                                                                                                                                                                                                                          frodoVersion?: string
                                                                                                                                                                                                                                                                                                                                                          host?: string
                                                                                                                                                                                                                                                                                                                                                          idmHost?: string
                                                                                                                                                                                                                                                                                                                                                          isIGA?: boolean
                                                                                                                                                                                                                                                                                                                                                          logApiKey?: string
                                                                                                                                                                                                                                                                                                                                                          logApiSecret?: string
                                                                                                                                                                                                                                                                                                                                                          masterKeyPath?: string
                                                                                                                                                                                                                                                                                                                                                          outputFile?: string
                                                                                                                                                                                                                                                                                                                                                          password?: string
                                                                                                                                                                                                                                                                                                                                                          printHandler?: (
                                                                                                                                                                                                                                                                                                                                                              message: string | object,
                                                                                                                                                                                                                                                                                                                                                              type?: string,
                                                                                                                                                                                                                                                                                                                                                              newline?: boolean,
                                                                                                                                                                                                                                                                                                                                                          ) => void
                                                                                                                                                                                                                                                                                                                                                          realm?: string
                                                                                                                                                                                                                                                                                                                                                          serviceAccountId?: string
                                                                                                                                                                                                                                                                                                                                                          serviceAccountJwk?: JwkRsa
                                                                                                                                                                                                                                                                                                                                                          serviceAccountScope?: string
                                                                                                                                                                                                                                                                                                                                                          stopProgressHandler?: (id: string, message: string, status?: string) => void
                                                                                                                                                                                                                                                                                                                                                          tokenCachePath?: string
                                                                                                                                                                                                                                                                                                                                                          updateProgressHandler?: (id: string, message: string) => void
                                                                                                                                                                                                                                                                                                                                                          useBearerTokenForAmApis?: boolean
                                                                                                                                                                                                                                                                                                                                                          useRealmPrefixOnManagedObjects?: boolean
                                                                                                                                                                                                                                                                                                                                                          username?: string
                                                                                                                                                                                                                                                                                                                                                          userSessionToken?: UserSessionMetaType
                                                                                                                                                                                                                                                                                                                                                          useTokenCache?: boolean
                                                                                                                                                                                                                                                                                                                                                          verbose?: boolean
                                                                                                                                                                                                                                                                                                                                                          verboseHandler?: (message: string | object) => void
                                                                                                                                                                                                                                                                                                                                                          diff --git a/docs/interfaces/Reference.SystemObjectPatchOperationInterface.html b/docs/interfaces/Reference.SystemObjectPatchOperationInterface.html index beb57531b..88e22d59e 100644 --- a/docs/interfaces/Reference.SystemObjectPatchOperationInterface.html +++ b/docs/interfaces/Reference.SystemObjectPatchOperationInterface.html @@ -1,5 +1,5 @@ -SystemObjectPatchOperationInterface | Frodo Library - v4.0.0-10
                                                                                                                                                                                                                                                                                                                                                          Frodo Library - v4.0.0-10
                                                                                                                                                                                                                                                                                                                                                            Preparing search index...

                                                                                                                                                                                                                                                                                                                                                            Interface SystemObjectPatchOperationInterface

                                                                                                                                                                                                                                                                                                                                                            interface SystemObjectPatchOperationInterface {
                                                                                                                                                                                                                                                                                                                                                                field: string;
                                                                                                                                                                                                                                                                                                                                                                from?: string;
                                                                                                                                                                                                                                                                                                                                                                operation:
                                                                                                                                                                                                                                                                                                                                                                    | "add"
                                                                                                                                                                                                                                                                                                                                                                    | "copy"
                                                                                                                                                                                                                                                                                                                                                                    | "increment"
                                                                                                                                                                                                                                                                                                                                                                    | "move"
                                                                                                                                                                                                                                                                                                                                                                    | "remove"
                                                                                                                                                                                                                                                                                                                                                                    | "replace"
                                                                                                                                                                                                                                                                                                                                                                    | "transform";
                                                                                                                                                                                                                                                                                                                                                                value?: any;
                                                                                                                                                                                                                                                                                                                                                            }
                                                                                                                                                                                                                                                                                                                                                            Index

                                                                                                                                                                                                                                                                                                                                                            Properties

                                                                                                                                                                                                                                                                                                                                                            field +SystemObjectPatchOperationInterface | Frodo Library - v4.0.0-11
                                                                                                                                                                                                                                                                                                                                                            Frodo Library - v4.0.0-11
                                                                                                                                                                                                                                                                                                                                                              Preparing search index...

                                                                                                                                                                                                                                                                                                                                                              Interface SystemObjectPatchOperationInterface

                                                                                                                                                                                                                                                                                                                                                              interface SystemObjectPatchOperationInterface {
                                                                                                                                                                                                                                                                                                                                                                  field: string;
                                                                                                                                                                                                                                                                                                                                                                  from?: string;
                                                                                                                                                                                                                                                                                                                                                                  operation:
                                                                                                                                                                                                                                                                                                                                                                      | "add"
                                                                                                                                                                                                                                                                                                                                                                      | "copy"
                                                                                                                                                                                                                                                                                                                                                                      | "increment"
                                                                                                                                                                                                                                                                                                                                                                      | "move"
                                                                                                                                                                                                                                                                                                                                                                      | "remove"
                                                                                                                                                                                                                                                                                                                                                                      | "replace"
                                                                                                                                                                                                                                                                                                                                                                      | "transform";
                                                                                                                                                                                                                                                                                                                                                                  value?: any;
                                                                                                                                                                                                                                                                                                                                                              }
                                                                                                                                                                                                                                                                                                                                                              Index

                                                                                                                                                                                                                                                                                                                                                              Properties

                                                                                                                                                                                                                                                                                                                                                              field: string
                                                                                                                                                                                                                                                                                                                                                              from?: string
                                                                                                                                                                                                                                                                                                                                                              operation:
                                                                                                                                                                                                                                                                                                                                                                  | "add"
                                                                                                                                                                                                                                                                                                                                                                  | "copy"
                                                                                                                                                                                                                                                                                                                                                                  | "increment"
                                                                                                                                                                                                                                                                                                                                                                  | "move"
                                                                                                                                                                                                                                                                                                                                                                  | "remove"
                                                                                                                                                                                                                                                                                                                                                                  | "replace"
                                                                                                                                                                                                                                                                                                                                                                  | "transform"
                                                                                                                                                                                                                                                                                                                                                              value?: any
                                                                                                                                                                                                                                                                                                                                                              +

                                                                                                                                                                                                                                                                                                                                                              Properties

                                                                                                                                                                                                                                                                                                                                                              field: string
                                                                                                                                                                                                                                                                                                                                                              from?: string
                                                                                                                                                                                                                                                                                                                                                              operation:
                                                                                                                                                                                                                                                                                                                                                                  | "add"
                                                                                                                                                                                                                                                                                                                                                                  | "copy"
                                                                                                                                                                                                                                                                                                                                                                  | "increment"
                                                                                                                                                                                                                                                                                                                                                                  | "move"
                                                                                                                                                                                                                                                                                                                                                                  | "remove"
                                                                                                                                                                                                                                                                                                                                                                  | "replace"
                                                                                                                                                                                                                                                                                                                                                                  | "transform"
                                                                                                                                                                                                                                                                                                                                                              value?: any
                                                                                                                                                                                                                                                                                                                                                              diff --git a/docs/interfaces/Reference.SystemStatusInterface.html b/docs/interfaces/Reference.SystemStatusInterface.html index d6bdcb151..2631ae59f 100644 --- a/docs/interfaces/Reference.SystemStatusInterface.html +++ b/docs/interfaces/Reference.SystemStatusInterface.html @@ -1,8 +1,8 @@ -SystemStatusInterface | Frodo Library - v4.0.0-10
                                                                                                                                                                                                                                                                                                                                                              Frodo Library - v4.0.0-10
                                                                                                                                                                                                                                                                                                                                                                Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                Interface SystemStatusInterface

                                                                                                                                                                                                                                                                                                                                                                interface SystemStatusInterface {
                                                                                                                                                                                                                                                                                                                                                                    config: string;
                                                                                                                                                                                                                                                                                                                                                                    connectorRef: {
                                                                                                                                                                                                                                                                                                                                                                        bundleName: string;
                                                                                                                                                                                                                                                                                                                                                                        bundleVersion: string;
                                                                                                                                                                                                                                                                                                                                                                        connectorHostRef: string;
                                                                                                                                                                                                                                                                                                                                                                        connectorName: string;
                                                                                                                                                                                                                                                                                                                                                                    };
                                                                                                                                                                                                                                                                                                                                                                    displayName: string;
                                                                                                                                                                                                                                                                                                                                                                    enabled: boolean;
                                                                                                                                                                                                                                                                                                                                                                    name: string;
                                                                                                                                                                                                                                                                                                                                                                    objectTypes: string[];
                                                                                                                                                                                                                                                                                                                                                                    ok: boolean;
                                                                                                                                                                                                                                                                                                                                                                }
                                                                                                                                                                                                                                                                                                                                                                Index

                                                                                                                                                                                                                                                                                                                                                                Properties

                                                                                                                                                                                                                                                                                                                                                                config +SystemStatusInterface | Frodo Library - v4.0.0-11
                                                                                                                                                                                                                                                                                                                                                                Frodo Library - v4.0.0-11
                                                                                                                                                                                                                                                                                                                                                                  Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                  Interface SystemStatusInterface

                                                                                                                                                                                                                                                                                                                                                                  interface SystemStatusInterface {
                                                                                                                                                                                                                                                                                                                                                                      config: string;
                                                                                                                                                                                                                                                                                                                                                                      connectorRef: {
                                                                                                                                                                                                                                                                                                                                                                          bundleName: string;
                                                                                                                                                                                                                                                                                                                                                                          bundleVersion: string;
                                                                                                                                                                                                                                                                                                                                                                          connectorHostRef: string;
                                                                                                                                                                                                                                                                                                                                                                          connectorName: string;
                                                                                                                                                                                                                                                                                                                                                                      };
                                                                                                                                                                                                                                                                                                                                                                      displayName: string;
                                                                                                                                                                                                                                                                                                                                                                      enabled: boolean;
                                                                                                                                                                                                                                                                                                                                                                      name: string;
                                                                                                                                                                                                                                                                                                                                                                      objectTypes: string[];
                                                                                                                                                                                                                                                                                                                                                                      ok: boolean;
                                                                                                                                                                                                                                                                                                                                                                  }
                                                                                                                                                                                                                                                                                                                                                                  Index

                                                                                                                                                                                                                                                                                                                                                                  Properties

                                                                                                                                                                                                                                                                                                                                                                  config: string
                                                                                                                                                                                                                                                                                                                                                                  connectorRef: {
                                                                                                                                                                                                                                                                                                                                                                      bundleName: string;
                                                                                                                                                                                                                                                                                                                                                                      bundleVersion: string;
                                                                                                                                                                                                                                                                                                                                                                      connectorHostRef: string;
                                                                                                                                                                                                                                                                                                                                                                      connectorName: string;
                                                                                                                                                                                                                                                                                                                                                                  }
                                                                                                                                                                                                                                                                                                                                                                  displayName: string
                                                                                                                                                                                                                                                                                                                                                                  enabled: boolean
                                                                                                                                                                                                                                                                                                                                                                  name: string
                                                                                                                                                                                                                                                                                                                                                                  objectTypes: string[]
                                                                                                                                                                                                                                                                                                                                                                  ok: boolean
                                                                                                                                                                                                                                                                                                                                                                  +

                                                                                                                                                                                                                                                                                                                                                                  Properties

                                                                                                                                                                                                                                                                                                                                                                  config: string
                                                                                                                                                                                                                                                                                                                                                                  connectorRef: {
                                                                                                                                                                                                                                                                                                                                                                      bundleName: string;
                                                                                                                                                                                                                                                                                                                                                                      bundleVersion: string;
                                                                                                                                                                                                                                                                                                                                                                      connectorHostRef: string;
                                                                                                                                                                                                                                                                                                                                                                      connectorName: string;
                                                                                                                                                                                                                                                                                                                                                                  }
                                                                                                                                                                                                                                                                                                                                                                  displayName: string
                                                                                                                                                                                                                                                                                                                                                                  enabled: boolean
                                                                                                                                                                                                                                                                                                                                                                  name: string
                                                                                                                                                                                                                                                                                                                                                                  objectTypes: string[]
                                                                                                                                                                                                                                                                                                                                                                  ok: boolean
                                                                                                                                                                                                                                                                                                                                                                  diff --git a/docs/interfaces/Reference.ThemeExportInterface.html b/docs/interfaces/Reference.ThemeExportInterface.html index 1a8a07716..020aeeb86 100644 --- a/docs/interfaces/Reference.ThemeExportInterface.html +++ b/docs/interfaces/Reference.ThemeExportInterface.html @@ -1,3 +1,3 @@ -ThemeExportInterface | Frodo Library - v4.0.0-10
                                                                                                                                                                                                                                                                                                                                                                  Frodo Library - v4.0.0-10
                                                                                                                                                                                                                                                                                                                                                                    Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                    Interface ThemeExportInterface

                                                                                                                                                                                                                                                                                                                                                                    interface ThemeExportInterface {
                                                                                                                                                                                                                                                                                                                                                                        meta?: ExportMetaData;
                                                                                                                                                                                                                                                                                                                                                                        theme: Record<string, ThemeSkeleton>;
                                                                                                                                                                                                                                                                                                                                                                    }
                                                                                                                                                                                                                                                                                                                                                                    Index

                                                                                                                                                                                                                                                                                                                                                                    Properties

                                                                                                                                                                                                                                                                                                                                                                    meta? +ThemeExportInterface | Frodo Library - v4.0.0-11
                                                                                                                                                                                                                                                                                                                                                                    Frodo Library - v4.0.0-11
                                                                                                                                                                                                                                                                                                                                                                      Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                      Interface ThemeExportInterface

                                                                                                                                                                                                                                                                                                                                                                      interface ThemeExportInterface {
                                                                                                                                                                                                                                                                                                                                                                          meta?: ExportMetaData;
                                                                                                                                                                                                                                                                                                                                                                          theme: Record<string, ThemeSkeleton>;
                                                                                                                                                                                                                                                                                                                                                                      }
                                                                                                                                                                                                                                                                                                                                                                      Index

                                                                                                                                                                                                                                                                                                                                                                      Properties

                                                                                                                                                                                                                                                                                                                                                                      Properties

                                                                                                                                                                                                                                                                                                                                                                      theme: Record<string, ThemeSkeleton>
                                                                                                                                                                                                                                                                                                                                                                      +

                                                                                                                                                                                                                                                                                                                                                                      Properties

                                                                                                                                                                                                                                                                                                                                                                      theme: Record<string, ThemeSkeleton>
                                                                                                                                                                                                                                                                                                                                                                      diff --git a/docs/interfaces/Reference.TokenCacheInterface.html b/docs/interfaces/Reference.TokenCacheInterface.html index c53ae6439..03720095c 100644 --- a/docs/interfaces/Reference.TokenCacheInterface.html +++ b/docs/interfaces/Reference.TokenCacheInterface.html @@ -1 +1 @@ -TokenCacheInterface | Frodo Library - v4.0.0-10
                                                                                                                                                                                                                                                                                                                                                                      Frodo Library - v4.0.0-10
                                                                                                                                                                                                                                                                                                                                                                        Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                        Interface TokenCacheInterface

                                                                                                                                                                                                                                                                                                                                                                        Indexable

                                                                                                                                                                                                                                                                                                                                                                        • [hostKey: string]: {
                                                                                                                                                                                                                                                                                                                                                                              [realmKey: string]: {
                                                                                                                                                                                                                                                                                                                                                                                  [typeKey in string | number | symbol]: {
                                                                                                                                                                                                                                                                                                                                                                                      [subjectKey: string]: { [expKey: string]: string };
                                                                                                                                                                                                                                                                                                                                                                                  }
                                                                                                                                                                                                                                                                                                                                                                              };
                                                                                                                                                                                                                                                                                                                                                                          }
                                                                                                                                                                                                                                                                                                                                                                        +TokenCacheInterface | Frodo Library - v4.0.0-11
                                                                                                                                                                                                                                                                                                                                                                        Frodo Library - v4.0.0-11
                                                                                                                                                                                                                                                                                                                                                                          Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                          Interface TokenCacheInterface

                                                                                                                                                                                                                                                                                                                                                                          Indexable

                                                                                                                                                                                                                                                                                                                                                                          • [hostKey: string]: {
                                                                                                                                                                                                                                                                                                                                                                                [realmKey: string]: {
                                                                                                                                                                                                                                                                                                                                                                                    [typeKey in string | number | symbol]: {
                                                                                                                                                                                                                                                                                                                                                                                        [subjectKey: string]: { [expKey: string]: string };
                                                                                                                                                                                                                                                                                                                                                                                    }
                                                                                                                                                                                                                                                                                                                                                                                };
                                                                                                                                                                                                                                                                                                                                                                            }
                                                                                                                                                                                                                                                                                                                                                                          diff --git a/docs/interfaces/Reference.TreeDependencyMapInterface.html b/docs/interfaces/Reference.TreeDependencyMapInterface.html index d16175c70..0261091b2 100644 --- a/docs/interfaces/Reference.TreeDependencyMapInterface.html +++ b/docs/interfaces/Reference.TreeDependencyMapInterface.html @@ -1 +1 @@ -TreeDependencyMapInterface | Frodo Library - v4.0.0-10
                                                                                                                                                                                                                                                                                                                                                                          Frodo Library - v4.0.0-10
                                                                                                                                                                                                                                                                                                                                                                            Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                            Interface TreeDependencyMapInterface

                                                                                                                                                                                                                                                                                                                                                                            Indexable

                                                                                                                                                                                                                                                                                                                                                                            +TreeDependencyMapInterface | Frodo Library - v4.0.0-11
                                                                                                                                                                                                                                                                                                                                                                            Frodo Library - v4.0.0-11
                                                                                                                                                                                                                                                                                                                                                                              Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                              Interface TreeDependencyMapInterface

                                                                                                                                                                                                                                                                                                                                                                              Indexable

                                                                                                                                                                                                                                                                                                                                                                              diff --git a/docs/interfaces/Reference.TreeExportOptions.html b/docs/interfaces/Reference.TreeExportOptions.html index 6a2a88638..9a68cce05 100644 --- a/docs/interfaces/Reference.TreeExportOptions.html +++ b/docs/interfaces/Reference.TreeExportOptions.html @@ -1,8 +1,8 @@ -TreeExportOptions | Frodo Library - v4.0.0-10
                                                                                                                                                                                                                                                                                                                                                                              Frodo Library - v4.0.0-10
                                                                                                                                                                                                                                                                                                                                                                                Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                Interface TreeExportOptions

                                                                                                                                                                                                                                                                                                                                                                                Tree export options

                                                                                                                                                                                                                                                                                                                                                                                -
                                                                                                                                                                                                                                                                                                                                                                                interface TreeExportOptions {
                                                                                                                                                                                                                                                                                                                                                                                    coords: boolean;
                                                                                                                                                                                                                                                                                                                                                                                    deps: boolean;
                                                                                                                                                                                                                                                                                                                                                                                    useStringArrays: boolean;
                                                                                                                                                                                                                                                                                                                                                                                }
                                                                                                                                                                                                                                                                                                                                                                                Index

                                                                                                                                                                                                                                                                                                                                                                                Properties

                                                                                                                                                                                                                                                                                                                                                                                coords +TreeExportOptions | Frodo Library - v4.0.0-11
                                                                                                                                                                                                                                                                                                                                                                                Frodo Library - v4.0.0-11
                                                                                                                                                                                                                                                                                                                                                                                  Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                  Interface TreeExportOptions

                                                                                                                                                                                                                                                                                                                                                                                  Tree export options

                                                                                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                                                                                  interface TreeExportOptions {
                                                                                                                                                                                                                                                                                                                                                                                      coords: boolean;
                                                                                                                                                                                                                                                                                                                                                                                      deps: boolean;
                                                                                                                                                                                                                                                                                                                                                                                      useStringArrays: boolean;
                                                                                                                                                                                                                                                                                                                                                                                  }
                                                                                                                                                                                                                                                                                                                                                                                  Index

                                                                                                                                                                                                                                                                                                                                                                                  Properties

                                                                                                                                                                                                                                                                                                                                                                                  coords: boolean

                                                                                                                                                                                                                                                                                                                                                                                  Include x and y coordinate positions of the journey/tree nodes.

                                                                                                                                                                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                                                                                                                                                                  deps: boolean

                                                                                                                                                                                                                                                                                                                                                                                  Include any dependencies specific to AIC (scripts, email templates, SAML entity providers and circles of trust, social identity providers, themes).

                                                                                                                                                                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                                                                                                                                                                  useStringArrays: boolean

                                                                                                                                                                                                                                                                                                                                                                                  Where applicable, use string arrays to store multi-line text (e.g. scripts).

                                                                                                                                                                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                                                                                  deps: boolean

                                                                                                                                                                                                                                                                                                                                                                                  Include any dependencies specific to AIC (scripts, email templates, SAML entity providers and circles of trust, social identity providers, themes).

                                                                                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                                                                                  useStringArrays: boolean

                                                                                                                                                                                                                                                                                                                                                                                  Where applicable, use string arrays to store multi-line text (e.g. scripts).

                                                                                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                                                                                  diff --git a/docs/interfaces/Reference.TreeExportResolverInterface.html b/docs/interfaces/Reference.TreeExportResolverInterface.html index 1ab67a4d3..4a76a6ca6 100644 --- a/docs/interfaces/Reference.TreeExportResolverInterface.html +++ b/docs/interfaces/Reference.TreeExportResolverInterface.html @@ -1 +1 @@ -TreeExportResolverInterface | Frodo Library - v4.0.0-10
                                                                                                                                                                                                                                                                                                                                                                                  Frodo Library - v4.0.0-10
                                                                                                                                                                                                                                                                                                                                                                                    Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                    Interface TreeExportResolverInterface

                                                                                                                                                                                                                                                                                                                                                                                    +TreeExportResolverInterface | Frodo Library - v4.0.0-11
                                                                                                                                                                                                                                                                                                                                                                                    Frodo Library - v4.0.0-11
                                                                                                                                                                                                                                                                                                                                                                                      Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                      Interface TreeExportResolverInterface

                                                                                                                                                                                                                                                                                                                                                                                      diff --git a/docs/interfaces/Reference.TreeImportOptions.html b/docs/interfaces/Reference.TreeImportOptions.html index f06a5b485..6e27e2166 100644 --- a/docs/interfaces/Reference.TreeImportOptions.html +++ b/docs/interfaces/Reference.TreeImportOptions.html @@ -1,6 +1,6 @@ -TreeImportOptions | Frodo Library - v4.0.0-10
                                                                                                                                                                                                                                                                                                                                                                                      Frodo Library - v4.0.0-10
                                                                                                                                                                                                                                                                                                                                                                                        Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                        Interface TreeImportOptions

                                                                                                                                                                                                                                                                                                                                                                                        Tree import options

                                                                                                                                                                                                                                                                                                                                                                                        -
                                                                                                                                                                                                                                                                                                                                                                                        interface TreeImportOptions {
                                                                                                                                                                                                                                                                                                                                                                                            deps: boolean;
                                                                                                                                                                                                                                                                                                                                                                                            reUuid: boolean;
                                                                                                                                                                                                                                                                                                                                                                                        }
                                                                                                                                                                                                                                                                                                                                                                                        Index

                                                                                                                                                                                                                                                                                                                                                                                        Properties

                                                                                                                                                                                                                                                                                                                                                                                        deps +TreeImportOptions | Frodo Library - v4.0.0-11
                                                                                                                                                                                                                                                                                                                                                                                        Frodo Library - v4.0.0-11
                                                                                                                                                                                                                                                                                                                                                                                          Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                          Interface TreeImportOptions

                                                                                                                                                                                                                                                                                                                                                                                          Tree import options

                                                                                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                                                                                          interface TreeImportOptions {
                                                                                                                                                                                                                                                                                                                                                                                              deps: boolean;
                                                                                                                                                                                                                                                                                                                                                                                              reUuid: boolean;
                                                                                                                                                                                                                                                                                                                                                                                          }
                                                                                                                                                                                                                                                                                                                                                                                          Index

                                                                                                                                                                                                                                                                                                                                                                                          Properties

                                                                                                                                                                                                                                                                                                                                                                                          Properties

                                                                                                                                                                                                                                                                                                                                                                                          deps: boolean

                                                                                                                                                                                                                                                                                                                                                                                          Include any dependencies specific to AIC or Frodo (scripts, email templates, SAML entity providers and circles of trust, social identity providers, themes, custom nodes).

                                                                                                                                                                                                                                                                                                                                                                                          -
                                                                                                                                                                                                                                                                                                                                                                                          reUuid: boolean

                                                                                                                                                                                                                                                                                                                                                                                          Generate new UUIDs for all nodes during import.

                                                                                                                                                                                                                                                                                                                                                                                          -
                                                                                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                                                                                          reUuid: boolean

                                                                                                                                                                                                                                                                                                                                                                                          Generate new UUIDs for all nodes during import.

                                                                                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                                                                                          diff --git a/docs/interfaces/Reference.UiConfigInterface.html b/docs/interfaces/Reference.UiConfigInterface.html index 00df64d2e..86a67c87c 100644 --- a/docs/interfaces/Reference.UiConfigInterface.html +++ b/docs/interfaces/Reference.UiConfigInterface.html @@ -1,2 +1,2 @@ -UiConfigInterface | Frodo Library - v4.0.0-10
                                                                                                                                                                                                                                                                                                                                                                                          Frodo Library - v4.0.0-10
                                                                                                                                                                                                                                                                                                                                                                                            Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                            Interface UiConfigInterface

                                                                                                                                                                                                                                                                                                                                                                                            interface UiConfigInterface {
                                                                                                                                                                                                                                                                                                                                                                                                categories: string;
                                                                                                                                                                                                                                                                                                                                                                                            }
                                                                                                                                                                                                                                                                                                                                                                                            Index

                                                                                                                                                                                                                                                                                                                                                                                            Properties

                                                                                                                                                                                                                                                                                                                                                                                            Properties

                                                                                                                                                                                                                                                                                                                                                                                            categories: string
                                                                                                                                                                                                                                                                                                                                                                                            +UiConfigInterface | Frodo Library - v4.0.0-11
                                                                                                                                                                                                                                                                                                                                                                                            Frodo Library - v4.0.0-11
                                                                                                                                                                                                                                                                                                                                                                                              Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                              Interface UiConfigInterface

                                                                                                                                                                                                                                                                                                                                                                                              interface UiConfigInterface {
                                                                                                                                                                                                                                                                                                                                                                                                  categories: string;
                                                                                                                                                                                                                                                                                                                                                                                              }
                                                                                                                                                                                                                                                                                                                                                                                              Index

                                                                                                                                                                                                                                                                                                                                                                                              Properties

                                                                                                                                                                                                                                                                                                                                                                                              Properties

                                                                                                                                                                                                                                                                                                                                                                                              categories: string
                                                                                                                                                                                                                                                                                                                                                                                              diff --git a/docs/interfaces/Reference.Updates.html b/docs/interfaces/Reference.Updates.html index 875539826..eba747303 100644 --- a/docs/interfaces/Reference.Updates.html +++ b/docs/interfaces/Reference.Updates.html @@ -1,6 +1,6 @@ -Updates | Frodo Library - v4.0.0-10
                                                                                                                                                                                                                                                                                                                                                                                              Frodo Library - v4.0.0-10
                                                                                                                                                                                                                                                                                                                                                                                                Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                Interface Updates

                                                                                                                                                                                                                                                                                                                                                                                                Updates that need to be applied.

                                                                                                                                                                                                                                                                                                                                                                                                -
                                                                                                                                                                                                                                                                                                                                                                                                interface Updates {
                                                                                                                                                                                                                                                                                                                                                                                                    secrets?: unknown[];
                                                                                                                                                                                                                                                                                                                                                                                                    variables?: unknown[];
                                                                                                                                                                                                                                                                                                                                                                                                }
                                                                                                                                                                                                                                                                                                                                                                                                Index

                                                                                                                                                                                                                                                                                                                                                                                                Properties

                                                                                                                                                                                                                                                                                                                                                                                                secrets? +Updates | Frodo Library - v4.0.0-11
                                                                                                                                                                                                                                                                                                                                                                                                Frodo Library - v4.0.0-11
                                                                                                                                                                                                                                                                                                                                                                                                  Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                  Interface Updates

                                                                                                                                                                                                                                                                                                                                                                                                  Updates that need to be applied.

                                                                                                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                                                                                                  interface Updates {
                                                                                                                                                                                                                                                                                                                                                                                                      secrets?: unknown[];
                                                                                                                                                                                                                                                                                                                                                                                                      variables?: unknown[];
                                                                                                                                                                                                                                                                                                                                                                                                  }
                                                                                                                                                                                                                                                                                                                                                                                                  Index

                                                                                                                                                                                                                                                                                                                                                                                                  Properties

                                                                                                                                                                                                                                                                                                                                                                                                  Properties

                                                                                                                                                                                                                                                                                                                                                                                                  secrets?: unknown[]

                                                                                                                                                                                                                                                                                                                                                                                                  Array of secrets that need applying

                                                                                                                                                                                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                                                                                                                                                                                  variables?: unknown[]

                                                                                                                                                                                                                                                                                                                                                                                                  Array of variables that need applying

                                                                                                                                                                                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                                                                                                  variables?: unknown[]

                                                                                                                                                                                                                                                                                                                                                                                                  Array of variables that need applying

                                                                                                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                                                                                                  diff --git a/docs/interfaces/Reference.UserExportInterface.html b/docs/interfaces/Reference.UserExportInterface.html index 45ba0a3d6..88f3b0d56 100644 --- a/docs/interfaces/Reference.UserExportInterface.html +++ b/docs/interfaces/Reference.UserExportInterface.html @@ -1,3 +1,3 @@ -UserExportInterface | Frodo Library - v4.0.0-10
                                                                                                                                                                                                                                                                                                                                                                                                  Frodo Library - v4.0.0-10
                                                                                                                                                                                                                                                                                                                                                                                                    Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                    Interface UserExportInterface

                                                                                                                                                                                                                                                                                                                                                                                                    interface UserExportInterface {
                                                                                                                                                                                                                                                                                                                                                                                                        meta?: ExportMetaData;
                                                                                                                                                                                                                                                                                                                                                                                                        user: Record<string, UserExportSkeleton>;
                                                                                                                                                                                                                                                                                                                                                                                                    }
                                                                                                                                                                                                                                                                                                                                                                                                    Index

                                                                                                                                                                                                                                                                                                                                                                                                    Properties

                                                                                                                                                                                                                                                                                                                                                                                                    meta? +UserExportInterface | Frodo Library - v4.0.0-11
                                                                                                                                                                                                                                                                                                                                                                                                    Frodo Library - v4.0.0-11
                                                                                                                                                                                                                                                                                                                                                                                                      Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                      Interface UserExportInterface

                                                                                                                                                                                                                                                                                                                                                                                                      interface UserExportInterface {
                                                                                                                                                                                                                                                                                                                                                                                                          meta?: ExportMetaData;
                                                                                                                                                                                                                                                                                                                                                                                                          user: Record<string, UserExportSkeleton>;
                                                                                                                                                                                                                                                                                                                                                                                                      }
                                                                                                                                                                                                                                                                                                                                                                                                      Index

                                                                                                                                                                                                                                                                                                                                                                                                      Properties

                                                                                                                                                                                                                                                                                                                                                                                                      Properties

                                                                                                                                                                                                                                                                                                                                                                                                      user: Record<string, UserExportSkeleton>
                                                                                                                                                                                                                                                                                                                                                                                                      +

                                                                                                                                                                                                                                                                                                                                                                                                      Properties

                                                                                                                                                                                                                                                                                                                                                                                                      user: Record<string, UserExportSkeleton>
                                                                                                                                                                                                                                                                                                                                                                                                      diff --git a/docs/interfaces/Reference.UserGroupExportInterface.html b/docs/interfaces/Reference.UserGroupExportInterface.html index 605f4188f..9cd6027cb 100644 --- a/docs/interfaces/Reference.UserGroupExportInterface.html +++ b/docs/interfaces/Reference.UserGroupExportInterface.html @@ -1,3 +1,3 @@ -UserGroupExportInterface | Frodo Library - v4.0.0-10
                                                                                                                                                                                                                                                                                                                                                                                                      Frodo Library - v4.0.0-10
                                                                                                                                                                                                                                                                                                                                                                                                        Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                        Interface UserGroupExportInterface

                                                                                                                                                                                                                                                                                                                                                                                                        interface UserGroupExportInterface {
                                                                                                                                                                                                                                                                                                                                                                                                            meta?: ExportMetaData;
                                                                                                                                                                                                                                                                                                                                                                                                            userGroup: Record<string, UserGroupSkeleton>;
                                                                                                                                                                                                                                                                                                                                                                                                        }
                                                                                                                                                                                                                                                                                                                                                                                                        Index

                                                                                                                                                                                                                                                                                                                                                                                                        Properties

                                                                                                                                                                                                                                                                                                                                                                                                        meta? +UserGroupExportInterface | Frodo Library - v4.0.0-11
                                                                                                                                                                                                                                                                                                                                                                                                        Frodo Library - v4.0.0-11
                                                                                                                                                                                                                                                                                                                                                                                                          Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                          Interface UserGroupExportInterface

                                                                                                                                                                                                                                                                                                                                                                                                          interface UserGroupExportInterface {
                                                                                                                                                                                                                                                                                                                                                                                                              meta?: ExportMetaData;
                                                                                                                                                                                                                                                                                                                                                                                                              userGroup: Record<string, UserGroupSkeleton>;
                                                                                                                                                                                                                                                                                                                                                                                                          }
                                                                                                                                                                                                                                                                                                                                                                                                          Index

                                                                                                                                                                                                                                                                                                                                                                                                          Properties

                                                                                                                                                                                                                                                                                                                                                                                                          Properties

                                                                                                                                                                                                                                                                                                                                                                                                          userGroup: Record<string, UserGroupSkeleton>
                                                                                                                                                                                                                                                                                                                                                                                                          +

                                                                                                                                                                                                                                                                                                                                                                                                          Properties

                                                                                                                                                                                                                                                                                                                                                                                                          userGroup: Record<string, UserGroupSkeleton>
                                                                                                                                                                                                                                                                                                                                                                                                          diff --git a/docs/interfaces/Reference.VariablesExportInterface.html b/docs/interfaces/Reference.VariablesExportInterface.html index 32509d403..fd1eb816f 100644 --- a/docs/interfaces/Reference.VariablesExportInterface.html +++ b/docs/interfaces/Reference.VariablesExportInterface.html @@ -1,3 +1,3 @@ -VariablesExportInterface | Frodo Library - v4.0.0-10
                                                                                                                                                                                                                                                                                                                                                                                                          Frodo Library - v4.0.0-10
                                                                                                                                                                                                                                                                                                                                                                                                            Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                            Interface VariablesExportInterface

                                                                                                                                                                                                                                                                                                                                                                                                            interface VariablesExportInterface {
                                                                                                                                                                                                                                                                                                                                                                                                                meta?: ExportMetaData;
                                                                                                                                                                                                                                                                                                                                                                                                                variable: Record<string, VariableSkeleton>;
                                                                                                                                                                                                                                                                                                                                                                                                            }
                                                                                                                                                                                                                                                                                                                                                                                                            Index

                                                                                                                                                                                                                                                                                                                                                                                                            Properties

                                                                                                                                                                                                                                                                                                                                                                                                            meta? +VariablesExportInterface | Frodo Library - v4.0.0-11
                                                                                                                                                                                                                                                                                                                                                                                                            Frodo Library - v4.0.0-11
                                                                                                                                                                                                                                                                                                                                                                                                              Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                              Interface VariablesExportInterface

                                                                                                                                                                                                                                                                                                                                                                                                              interface VariablesExportInterface {
                                                                                                                                                                                                                                                                                                                                                                                                                  meta?: ExportMetaData;
                                                                                                                                                                                                                                                                                                                                                                                                                  variable: Record<string, VariableSkeleton>;
                                                                                                                                                                                                                                                                                                                                                                                                              }
                                                                                                                                                                                                                                                                                                                                                                                                              Index

                                                                                                                                                                                                                                                                                                                                                                                                              Properties

                                                                                                                                                                                                                                                                                                                                                                                                              Properties

                                                                                                                                                                                                                                                                                                                                                                                                              variable: Record<string, VariableSkeleton>
                                                                                                                                                                                                                                                                                                                                                                                                              +

                                                                                                                                                                                                                                                                                                                                                                                                              Properties

                                                                                                                                                                                                                                                                                                                                                                                                              variable: Record<string, VariableSkeleton>
                                                                                                                                                                                                                                                                                                                                                                                                              diff --git a/docs/modules.html b/docs/modules.html index a43b34c1a..ac7de241a 100644 --- a/docs/modules.html +++ b/docs/modules.html @@ -1 +1 @@ -Frodo Library - v4.0.0-10
                                                                                                                                                                                                                                                                                                                                                                                                              Frodo Library - v4.0.0-10
                                                                                                                                                                                                                                                                                                                                                                                                                Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                  Frodo Library - v4.0.0-10

                                                                                                                                                                                                                                                                                                                                                                                                                  Modules

                                                                                                                                                                                                                                                                                                                                                                                                                  Reference

                                                                                                                                                                                                                                                                                                                                                                                                                  Classes

                                                                                                                                                                                                                                                                                                                                                                                                                  FrodoError

                                                                                                                                                                                                                                                                                                                                                                                                                  Variables

                                                                                                                                                                                                                                                                                                                                                                                                                  frodo
                                                                                                                                                                                                                                                                                                                                                                                                                  state
                                                                                                                                                                                                                                                                                                                                                                                                                  +Frodo Library - v4.0.0-11
                                                                                                                                                                                                                                                                                                                                                                                                                  Frodo Library - v4.0.0-11
                                                                                                                                                                                                                                                                                                                                                                                                                    Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                      Frodo Library - v4.0.0-11

                                                                                                                                                                                                                                                                                                                                                                                                                      Modules

                                                                                                                                                                                                                                                                                                                                                                                                                      Reference

                                                                                                                                                                                                                                                                                                                                                                                                                      Classes

                                                                                                                                                                                                                                                                                                                                                                                                                      FrodoError

                                                                                                                                                                                                                                                                                                                                                                                                                      Variables

                                                                                                                                                                                                                                                                                                                                                                                                                      frodo
                                                                                                                                                                                                                                                                                                                                                                                                                      state
                                                                                                                                                                                                                                                                                                                                                                                                                      diff --git a/docs/modules/Reference.html b/docs/modules/Reference.html index 0fd30d7e1..0e64f0658 100644 --- a/docs/modules/Reference.html +++ b/docs/modules/Reference.html @@ -1,4 +1,4 @@ -Reference | Frodo Library - v4.0.0-10
                                                                                                                                                                                                                                                                                                                                                                                                                      Frodo Library - v4.0.0-10
                                                                                                                                                                                                                                                                                                                                                                                                                        Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                        Module Reference

                                                                                                                                                                                                                                                                                                                                                                                                                        Enumerations

                                                                                                                                                                                                                                                                                                                                                                                                                        EnforcementGroup

                                                                                                                                                                                                                                                                                                                                                                                                                        Interfaces

                                                                                                                                                                                                                                                                                                                                                                                                                        AdminFederationExportInterface
                                                                                                                                                                                                                                                                                                                                                                                                                        AgentExportInterface
                                                                                                                                                                                                                                                                                                                                                                                                                        AgentGroupExportInterface
                                                                                                                                                                                                                                                                                                                                                                                                                        AmConfigEntitiesInterface
                                                                                                                                                                                                                                                                                                                                                                                                                        AmConfigEntityInterface
                                                                                                                                                                                                                                                                                                                                                                                                                        ApplicationExportInterface
                                                                                                                                                                                                                                                                                                                                                                                                                        AuthenticationSettingsExportInterface
                                                                                                                                                                                                                                                                                                                                                                                                                        CirclesOfTrustExportInterface
                                                                                                                                                                                                                                                                                                                                                                                                                        ConfigEntityExportInterface
                                                                                                                                                                                                                                                                                                                                                                                                                        ConfigEntityExportInterface
                                                                                                                                                                                                                                                                                                                                                                                                                        ConfigEntityExportOptions
                                                                                                                                                                                                                                                                                                                                                                                                                        ConfigEntityImportOptions
                                                                                                                                                                                                                                                                                                                                                                                                                        ConnectionProfileInterface
                                                                                                                                                                                                                                                                                                                                                                                                                        ConnectionsFileInterface
                                                                                                                                                                                                                                                                                                                                                                                                                        ConnectorExportInterface
                                                                                                                                                                                                                                                                                                                                                                                                                        ConnectorExportOptions
                                                                                                                                                                                                                                                                                                                                                                                                                        ConnectorImportOptions
                                                                                                                                                                                                                                                                                                                                                                                                                        ConnectorServerStatusInterface
                                                                                                                                                                                                                                                                                                                                                                                                                        CustomNodeExportInterface
                                                                                                                                                                                                                                                                                                                                                                                                                        CustomNodeExportOptions
                                                                                                                                                                                                                                                                                                                                                                                                                        CustomNodeImportOptions
                                                                                                                                                                                                                                                                                                                                                                                                                        EmailTemplateExportInterface
                                                                                                                                                                                                                                                                                                                                                                                                                        EnvInfoInterface
                                                                                                                                                                                                                                                                                                                                                                                                                        ExportMetaData
                                                                                                                                                                                                                                                                                                                                                                                                                        FeatureInterface
                                                                                                                                                                                                                                                                                                                                                                                                                        FullExportInterface
                                                                                                                                                                                                                                                                                                                                                                                                                        FullExportOptions
                                                                                                                                                                                                                                                                                                                                                                                                                        FullGlobalExportInterface
                                                                                                                                                                                                                                                                                                                                                                                                                        FullImportOptions
                                                                                                                                                                                                                                                                                                                                                                                                                        FullRealmExportInterface
                                                                                                                                                                                                                                                                                                                                                                                                                        FullService
                                                                                                                                                                                                                                                                                                                                                                                                                        IdObjectSkeletonInterface
                                                                                                                                                                                                                                                                                                                                                                                                                        InnerNodeRefSkeletonInterface
                                                                                                                                                                                                                                                                                                                                                                                                                        InternalRoleExportInterface
                                                                                                                                                                                                                                                                                                                                                                                                                        JwkInterface
                                                                                                                                                                                                                                                                                                                                                                                                                        JwksInterface
                                                                                                                                                                                                                                                                                                                                                                                                                        MappingExportInterface
                                                                                                                                                                                                                                                                                                                                                                                                                        MappingExportOptions
                                                                                                                                                                                                                                                                                                                                                                                                                        MappingImportOptions
                                                                                                                                                                                                                                                                                                                                                                                                                        MultiTreeExportInterface
                                                                                                                                                                                                                                                                                                                                                                                                                        NodeExportInterface
                                                                                                                                                                                                                                                                                                                                                                                                                        NodeRefSkeletonInterface
                                                                                                                                                                                                                                                                                                                                                                                                                        NoIdObjectSkeletonInterface
                                                                                                                                                                                                                                                                                                                                                                                                                        OAuth2ClientExportInterface
                                                                                                                                                                                                                                                                                                                                                                                                                        OAuth2ClientExportOptions
                                                                                                                                                                                                                                                                                                                                                                                                                        OAuth2ClientImportOptions
                                                                                                                                                                                                                                                                                                                                                                                                                        OAuth2TrustedJwtIssuerExportInterface
                                                                                                                                                                                                                                                                                                                                                                                                                        OAuth2TrustedJwtIssuerExportOptions
                                                                                                                                                                                                                                                                                                                                                                                                                        OAuth2TrustedJwtIssuerImportOptions
                                                                                                                                                                                                                                                                                                                                                                                                                        PatchOperationInterface
                                                                                                                                                                                                                                                                                                                                                                                                                        PlatformInfoInterface
                                                                                                                                                                                                                                                                                                                                                                                                                        PolicyExportInterface
                                                                                                                                                                                                                                                                                                                                                                                                                        PolicyExportOptions
                                                                                                                                                                                                                                                                                                                                                                                                                        PolicyImportOptions
                                                                                                                                                                                                                                                                                                                                                                                                                        PolicySetExportInterface
                                                                                                                                                                                                                                                                                                                                                                                                                        PolicySetExportOptions
                                                                                                                                                                                                                                                                                                                                                                                                                        PolicySetImportOptions
                                                                                                                                                                                                                                                                                                                                                                                                                        RawExportOptions
                                                                                                                                                                                                                                                                                                                                                                                                                        RealmExportInterface
                                                                                                                                                                                                                                                                                                                                                                                                                        ResourceTypeExportInterface
                                                                                                                                                                                                                                                                                                                                                                                                                        Saml2EntitiesExportOptions
                                                                                                                                                                                                                                                                                                                                                                                                                        Saml2EntitiesImportOptions
                                                                                                                                                                                                                                                                                                                                                                                                                        Saml2ExportInterface
                                                                                                                                                                                                                                                                                                                                                                                                                        ScriptExportInterface
                                                                                                                                                                                                                                                                                                                                                                                                                        ScriptExportOptions
                                                                                                                                                                                                                                                                                                                                                                                                                        ScriptImportOptions
                                                                                                                                                                                                                                                                                                                                                                                                                        ScriptTypeExportInterface
                                                                                                                                                                                                                                                                                                                                                                                                                        SecretsExportInterface
                                                                                                                                                                                                                                                                                                                                                                                                                        SecretStoreExportInterface
                                                                                                                                                                                                                                                                                                                                                                                                                        SecureConnectionProfileInterface
                                                                                                                                                                                                                                                                                                                                                                                                                        ServerExportInterface
                                                                                                                                                                                                                                                                                                                                                                                                                        ServerExportOptions
                                                                                                                                                                                                                                                                                                                                                                                                                        ServerImportOptions
                                                                                                                                                                                                                                                                                                                                                                                                                        ServiceExportInterface
                                                                                                                                                                                                                                                                                                                                                                                                                        ServiceImportOptions
                                                                                                                                                                                                                                                                                                                                                                                                                        ServiceNextDescendent
                                                                                                                                                                                                                                                                                                                                                                                                                        SingleTreeExportInterface
                                                                                                                                                                                                                                                                                                                                                                                                                        SiteExportInterface
                                                                                                                                                                                                                                                                                                                                                                                                                        SocialIdentityProviderExportOptions
                                                                                                                                                                                                                                                                                                                                                                                                                        SocialIdentityProviderImportOptions
                                                                                                                                                                                                                                                                                                                                                                                                                        SocialProviderExportInterface
                                                                                                                                                                                                                                                                                                                                                                                                                        StateInterface
                                                                                                                                                                                                                                                                                                                                                                                                                        SystemObjectPatchOperationInterface
                                                                                                                                                                                                                                                                                                                                                                                                                        SystemStatusInterface
                                                                                                                                                                                                                                                                                                                                                                                                                        ThemeExportInterface
                                                                                                                                                                                                                                                                                                                                                                                                                        TokenCacheInterface
                                                                                                                                                                                                                                                                                                                                                                                                                        TreeDependencyMapInterface
                                                                                                                                                                                                                                                                                                                                                                                                                        TreeExportOptions
                                                                                                                                                                                                                                                                                                                                                                                                                        TreeExportResolverInterface
                                                                                                                                                                                                                                                                                                                                                                                                                        TreeImportOptions
                                                                                                                                                                                                                                                                                                                                                                                                                        UiConfigInterface
                                                                                                                                                                                                                                                                                                                                                                                                                        Updates
                                                                                                                                                                                                                                                                                                                                                                                                                        UserExportInterface
                                                                                                                                                                                                                                                                                                                                                                                                                        UserGroupExportInterface
                                                                                                                                                                                                                                                                                                                                                                                                                        VariablesExportInterface

                                                                                                                                                                                                                                                                                                                                                                                                                        Type Aliases

                                                                                                                                                                                                                                                                                                                                                                                                                        AccessTokenMetaType
                                                                                                                                                                                                                                                                                                                                                                                                                        AccessTokenResponseType
                                                                                                                                                                                                                                                                                                                                                                                                                        Admin
                                                                                                                                                                                                                                                                                                                                                                                                                        AdminFederation
                                                                                                                                                                                                                                                                                                                                                                                                                        AdminFederationConfigSkeleton
                                                                                                                                                                                                                                                                                                                                                                                                                        Agent
                                                                                                                                                                                                                                                                                                                                                                                                                        AgentGroupSkeleton
                                                                                                                                                                                                                                                                                                                                                                                                                        AgentSkeleton
                                                                                                                                                                                                                                                                                                                                                                                                                        AgentType
                                                                                                                                                                                                                                                                                                                                                                                                                        AllFlag
                                                                                                                                                                                                                                                                                                                                                                                                                        AllowDuplicatesFlag
                                                                                                                                                                                                                                                                                                                                                                                                                        AmConfig
                                                                                                                                                                                                                                                                                                                                                                                                                        AmServiceSkeleton
                                                                                                                                                                                                                                                                                                                                                                                                                        ApiFactory
                                                                                                                                                                                                                                                                                                                                                                                                                        ApiVersion
                                                                                                                                                                                                                                                                                                                                                                                                                        Application
                                                                                                                                                                                                                                                                                                                                                                                                                        ApplicationExportOptions
                                                                                                                                                                                                                                                                                                                                                                                                                        ApplicationImportOptions
                                                                                                                                                                                                                                                                                                                                                                                                                        ApplicationSkeleton
                                                                                                                                                                                                                                                                                                                                                                                                                        Authenticate
                                                                                                                                                                                                                                                                                                                                                                                                                        AuthenticateSuccessResponse
                                                                                                                                                                                                                                                                                                                                                                                                                        AuthenticationSettings
                                                                                                                                                                                                                                                                                                                                                                                                                        AuthenticationSettingsSkeleton
                                                                                                                                                                                                                                                                                                                                                                                                                        Base64
                                                                                                                                                                                                                                                                                                                                                                                                                        Callback
                                                                                                                                                                                                                                                                                                                                                                                                                        CallbackHandler
                                                                                                                                                                                                                                                                                                                                                                                                                        CallbackKeyValuePair
                                                                                                                                                                                                                                                                                                                                                                                                                        CallbackType
                                                                                                                                                                                                                                                                                                                                                                                                                        CertificateResponse
                                                                                                                                                                                                                                                                                                                                                                                                                        CircleOfTrustSkeleton
                                                                                                                                                                                                                                                                                                                                                                                                                        CirclesOfTrust
                                                                                                                                                                                                                                                                                                                                                                                                                        Config
                                                                                                                                                                                                                                                                                                                                                                                                                        ConfigSkeleton
                                                                                                                                                                                                                                                                                                                                                                                                                        ConnectionProfile
                                                                                                                                                                                                                                                                                                                                                                                                                        Connector
                                                                                                                                                                                                                                                                                                                                                                                                                        ConnectorSkeleton
                                                                                                                                                                                                                                                                                                                                                                                                                        Constants
                                                                                                                                                                                                                                                                                                                                                                                                                        ContentSecurityPolicy
                                                                                                                                                                                                                                                                                                                                                                                                                        CookieDomains
                                                                                                                                                                                                                                                                                                                                                                                                                        CSR
                                                                                                                                                                                                                                                                                                                                                                                                                        CSRResponse
                                                                                                                                                                                                                                                                                                                                                                                                                        CustomDomains
                                                                                                                                                                                                                                                                                                                                                                                                                        CustomNodeProperty
                                                                                                                                                                                                                                                                                                                                                                                                                        CustomNodeSkeleton
                                                                                                                                                                                                                                                                                                                                                                                                                        CustomNodeUsage
                                                                                                                                                                                                                                                                                                                                                                                                                        DeleteJourneysStatus
                                                                                                                                                                                                                                                                                                                                                                                                                        DeleteJourneyStatus
                                                                                                                                                                                                                                                                                                                                                                                                                        DirectiveEnabled
                                                                                                                                                                                                                                                                                                                                                                                                                        DirectiveFlag
                                                                                                                                                                                                                                                                                                                                                                                                                        DirectiveSource
                                                                                                                                                                                                                                                                                                                                                                                                                        DirectiveSourceFlag
                                                                                                                                                                                                                                                                                                                                                                                                                        EmailTemplate
                                                                                                                                                                                                                                                                                                                                                                                                                        EmailTemplateSkeleton
                                                                                                                                                                                                                                                                                                                                                                                                                        EngineConfigurationSkeleton
                                                                                                                                                                                                                                                                                                                                                                                                                        EntityType
                                                                                                                                                                                                                                                                                                                                                                                                                        EnvCertificate
                                                                                                                                                                                                                                                                                                                                                                                                                        EnvContentSecurityPolicy
                                                                                                                                                                                                                                                                                                                                                                                                                        EnvCookieDomains
                                                                                                                                                                                                                                                                                                                                                                                                                        EnvCSR
                                                                                                                                                                                                                                                                                                                                                                                                                        EnvCustomDomains
                                                                                                                                                                                                                                                                                                                                                                                                                        EnvFederationEnforcement
                                                                                                                                                                                                                                                                                                                                                                                                                        EnvironmentAndSystemPropertySecretStoreSkeleton
                                                                                                                                                                                                                                                                                                                                                                                                                        EnvPromotion
                                                                                                                                                                                                                                                                                                                                                                                                                        EnvRelease
                                                                                                                                                                                                                                                                                                                                                                                                                        EnvServiceAccountScopes
                                                                                                                                                                                                                                                                                                                                                                                                                        EnvSSOCookieConfig
                                                                                                                                                                                                                                                                                                                                                                                                                        EsvCount
                                                                                                                                                                                                                                                                                                                                                                                                                        EsvCountResponse
                                                                                                                                                                                                                                                                                                                                                                                                                        ExportImport
                                                                                                                                                                                                                                                                                                                                                                                                                        Feature
                                                                                                                                                                                                                                                                                                                                                                                                                        FederationEnforcement
                                                                                                                                                                                                                                                                                                                                                                                                                        FileSystemSecretStoreSkeleton
                                                                                                                                                                                                                                                                                                                                                                                                                        Frodo
                                                                                                                                                                                                                                                                                                                                                                                                                        FrodoCrypto
                                                                                                                                                                                                                                                                                                                                                                                                                        FRUtils
                                                                                                                                                                                                                                                                                                                                                                                                                        GatewayAgentType
                                                                                                                                                                                                                                                                                                                                                                                                                        GoogleKeyManagementServiceSecretStoreSkeleton
                                                                                                                                                                                                                                                                                                                                                                                                                        GoogleSecretManagerSecretStoreProviderSkeleton
                                                                                                                                                                                                                                                                                                                                                                                                                        HsmSecretStoreSkeleton
                                                                                                                                                                                                                                                                                                                                                                                                                        IdmConfig
                                                                                                                                                                                                                                                                                                                                                                                                                        IdmConfigStub
                                                                                                                                                                                                                                                                                                                                                                                                                        IdmCrypto
                                                                                                                                                                                                                                                                                                                                                                                                                        IdmScript
                                                                                                                                                                                                                                                                                                                                                                                                                        IdmSystem
                                                                                                                                                                                                                                                                                                                                                                                                                        Idp
                                                                                                                                                                                                                                                                                                                                                                                                                        Info
                                                                                                                                                                                                                                                                                                                                                                                                                        InternalRole
                                                                                                                                                                                                                                                                                                                                                                                                                        InternalRoleSkeleton
                                                                                                                                                                                                                                                                                                                                                                                                                        JavaAgentType
                                                                                                                                                                                                                                                                                                                                                                                                                        Jose
                                                                                                                                                                                                                                                                                                                                                                                                                        Journey
                                                                                                                                                                                                                                                                                                                                                                                                                        JourneyClassificationType
                                                                                                                                                                                                                                                                                                                                                                                                                        Json
                                                                                                                                                                                                                                                                                                                                                                                                                        JwkRsa
                                                                                                                                                                                                                                                                                                                                                                                                                        JwkRsaPublic
                                                                                                                                                                                                                                                                                                                                                                                                                        KeyStoreSecretStoreSkeleton
                                                                                                                                                                                                                                                                                                                                                                                                                        LockResponse
                                                                                                                                                                                                                                                                                                                                                                                                                        LockStatus
                                                                                                                                                                                                                                                                                                                                                                                                                        Log
                                                                                                                                                                                                                                                                                                                                                                                                                        LogApiKey
                                                                                                                                                                                                                                                                                                                                                                                                                        LogEventPayloadSkeleton
                                                                                                                                                                                                                                                                                                                                                                                                                        LogEventSkeleton
                                                                                                                                                                                                                                                                                                                                                                                                                        ManagedObject
                                                                                                                                                                                                                                                                                                                                                                                                                        Mapping
                                                                                                                                                                                                                                                                                                                                                                                                                        MappingPolicy
                                                                                                                                                                                                                                                                                                                                                                                                                        MappingProperty
                                                                                                                                                                                                                                                                                                                                                                                                                        MappingSkeleton
                                                                                                                                                                                                                                                                                                                                                                                                                        Node
                                                                                                                                                                                                                                                                                                                                                                                                                        NodeClassificationType
                                                                                                                                                                                                                                                                                                                                                                                                                        NodeSkeleton
                                                                                                                                                                                                                                                                                                                                                                                                                        NoneFlag
                                                                                                                                                                                                                                                                                                                                                                                                                        OAuth2Client
                                                                                                                                                                                                                                                                                                                                                                                                                        OAuth2ClientSkeleton
                                                                                                                                                                                                                                                                                                                                                                                                                        OAuth2Oidc
                                                                                                                                                                                                                                                                                                                                                                                                                        OAuth2Provider
                                                                                                                                                                                                                                                                                                                                                                                                                        OAuth2ProviderSkeleton
                                                                                                                                                                                                                                                                                                                                                                                                                        OAuth2ThingType
                                                                                                                                                                                                                                                                                                                                                                                                                        OAuth2TrustedJwtIssuer
                                                                                                                                                                                                                                                                                                                                                                                                                        OAuth2TrustedJwtIssuerSkeleton
                                                                                                                                                                                                                                                                                                                                                                                                                        ObjectPropertyFlag
                                                                                                                                                                                                                                                                                                                                                                                                                        ObjectPropertyNativeType
                                                                                                                                                                                                                                                                                                                                                                                                                        ObjectPropertySkeleton
                                                                                                                                                                                                                                                                                                                                                                                                                        ObjectPropertyType
                                                                                                                                                                                                                                                                                                                                                                                                                        ObjectTypeSkeleton
                                                                                                                                                                                                                                                                                                                                                                                                                        Organization
                                                                                                                                                                                                                                                                                                                                                                                                                        PagedResult
                                                                                                                                                                                                                                                                                                                                                                                                                        PlatformInfo
                                                                                                                                                                                                                                                                                                                                                                                                                        Policy
                                                                                                                                                                                                                                                                                                                                                                                                                        PolicyAgentType
                                                                                                                                                                                                                                                                                                                                                                                                                        PolicyCondition
                                                                                                                                                                                                                                                                                                                                                                                                                        PolicyConditionType
                                                                                                                                                                                                                                                                                                                                                                                                                        PolicySet
                                                                                                                                                                                                                                                                                                                                                                                                                        PolicySetSkeleton
                                                                                                                                                                                                                                                                                                                                                                                                                        PolicySkeleton
                                                                                                                                                                                                                                                                                                                                                                                                                        ProgressIndicatorStatusType
                                                                                                                                                                                                                                                                                                                                                                                                                        ProgressIndicatorType
                                                                                                                                                                                                                                                                                                                                                                                                                        PromotionConfig
                                                                                                                                                                                                                                                                                                                                                                                                                        PromotionConfigChange
                                                                                                                                                                                                                                                                                                                                                                                                                        PromotionReport
                                                                                                                                                                                                                                                                                                                                                                                                                        PromotionReportStub
                                                                                                                                                                                                                                                                                                                                                                                                                        PromotionRequestConfig
                                                                                                                                                                                                                                                                                                                                                                                                                        PromotionResponse
                                                                                                                                                                                                                                                                                                                                                                                                                        PromotionStatus
                                                                                                                                                                                                                                                                                                                                                                                                                        PromotionType
                                                                                                                                                                                                                                                                                                                                                                                                                        RawConfig
                                                                                                                                                                                                                                                                                                                                                                                                                        Readable
                                                                                                                                                                                                                                                                                                                                                                                                                        Realm
                                                                                                                                                                                                                                                                                                                                                                                                                        RealmSkeleton
                                                                                                                                                                                                                                                                                                                                                                                                                        Recon
                                                                                                                                                                                                                                                                                                                                                                                                                        ReconStatusType
                                                                                                                                                                                                                                                                                                                                                                                                                        ReconType
                                                                                                                                                                                                                                                                                                                                                                                                                        RefererDirectiveFlag
                                                                                                                                                                                                                                                                                                                                                                                                                        Release
                                                                                                                                                                                                                                                                                                                                                                                                                        RemoteConsentAgentType
                                                                                                                                                                                                                                                                                                                                                                                                                        ResourceConfig
                                                                                                                                                                                                                                                                                                                                                                                                                        ResourceType
                                                                                                                                                                                                                                                                                                                                                                                                                        ResourceTypeSkeleton
                                                                                                                                                                                                                                                                                                                                                                                                                        ResultCallback
                                                                                                                                                                                                                                                                                                                                                                                                                        RetryEverythingStrategy
                                                                                                                                                                                                                                                                                                                                                                                                                        RetryNetworkStrategy
                                                                                                                                                                                                                                                                                                                                                                                                                        RetryNothingStrategy
                                                                                                                                                                                                                                                                                                                                                                                                                        RetryStrategy
                                                                                                                                                                                                                                                                                                                                                                                                                        RollbackConfig
                                                                                                                                                                                                                                                                                                                                                                                                                        RollbackResponse
                                                                                                                                                                                                                                                                                                                                                                                                                        Saml2
                                                                                                                                                                                                                                                                                                                                                                                                                        Saml2ProiderLocation
                                                                                                                                                                                                                                                                                                                                                                                                                        Saml2ProviderSkeleton
                                                                                                                                                                                                                                                                                                                                                                                                                        Saml2ProviderStub
                                                                                                                                                                                                                                                                                                                                                                                                                        SandboxDirectiveFlag
                                                                                                                                                                                                                                                                                                                                                                                                                        Script
                                                                                                                                                                                                                                                                                                                                                                                                                        ScriptContext
                                                                                                                                                                                                                                                                                                                                                                                                                        ScriptFlag
                                                                                                                                                                                                                                                                                                                                                                                                                        ScriptingContextSkeleton
                                                                                                                                                                                                                                                                                                                                                                                                                        ScriptLanguage
                                                                                                                                                                                                                                                                                                                                                                                                                        ScriptSkeleton
                                                                                                                                                                                                                                                                                                                                                                                                                        ScriptType
                                                                                                                                                                                                                                                                                                                                                                                                                        ScriptTypeExportSkeleton
                                                                                                                                                                                                                                                                                                                                                                                                                        ScriptTypeSkeleton
                                                                                                                                                                                                                                                                                                                                                                                                                        ScriptValidation
                                                                                                                                                                                                                                                                                                                                                                                                                        Secret
                                                                                                                                                                                                                                                                                                                                                                                                                        SecretEncodingType

                                                                                                                                                                                                                                                                                                                                                                                                                        You can use the encoding parameter to set an encoding format when you create an ESV secret. +Reference | Frodo Library - v4.0.0-11

                                                                                                                                                                                                                                                                                                                                                                                                                        Frodo Library - v4.0.0-11
                                                                                                                                                                                                                                                                                                                                                                                                                          Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                          Module Reference

                                                                                                                                                                                                                                                                                                                                                                                                                          Enumerations

                                                                                                                                                                                                                                                                                                                                                                                                                          EnforcementGroup

                                                                                                                                                                                                                                                                                                                                                                                                                          Interfaces

                                                                                                                                                                                                                                                                                                                                                                                                                          AdminFederationExportInterface
                                                                                                                                                                                                                                                                                                                                                                                                                          AgentExportInterface
                                                                                                                                                                                                                                                                                                                                                                                                                          AgentGroupExportInterface
                                                                                                                                                                                                                                                                                                                                                                                                                          AmConfigEntitiesInterface
                                                                                                                                                                                                                                                                                                                                                                                                                          AmConfigEntityInterface
                                                                                                                                                                                                                                                                                                                                                                                                                          ApplicationExportInterface
                                                                                                                                                                                                                                                                                                                                                                                                                          AuthenticationSettingsExportInterface
                                                                                                                                                                                                                                                                                                                                                                                                                          CirclesOfTrustExportInterface
                                                                                                                                                                                                                                                                                                                                                                                                                          ConfigEntityExportInterface
                                                                                                                                                                                                                                                                                                                                                                                                                          ConfigEntityExportInterface
                                                                                                                                                                                                                                                                                                                                                                                                                          ConfigEntityExportOptions
                                                                                                                                                                                                                                                                                                                                                                                                                          ConfigEntityImportOptions
                                                                                                                                                                                                                                                                                                                                                                                                                          ConnectionProfileInterface
                                                                                                                                                                                                                                                                                                                                                                                                                          ConnectionsFileInterface
                                                                                                                                                                                                                                                                                                                                                                                                                          ConnectorExportInterface
                                                                                                                                                                                                                                                                                                                                                                                                                          ConnectorExportOptions
                                                                                                                                                                                                                                                                                                                                                                                                                          ConnectorImportOptions
                                                                                                                                                                                                                                                                                                                                                                                                                          ConnectorServerStatusInterface
                                                                                                                                                                                                                                                                                                                                                                                                                          CustomNodeExportInterface
                                                                                                                                                                                                                                                                                                                                                                                                                          CustomNodeExportOptions
                                                                                                                                                                                                                                                                                                                                                                                                                          CustomNodeImportOptions
                                                                                                                                                                                                                                                                                                                                                                                                                          EmailTemplateExportInterface
                                                                                                                                                                                                                                                                                                                                                                                                                          EnvInfoInterface
                                                                                                                                                                                                                                                                                                                                                                                                                          ExportMetaData
                                                                                                                                                                                                                                                                                                                                                                                                                          FeatureInterface
                                                                                                                                                                                                                                                                                                                                                                                                                          FullExportInterface
                                                                                                                                                                                                                                                                                                                                                                                                                          FullExportOptions
                                                                                                                                                                                                                                                                                                                                                                                                                          FullGlobalExportInterface
                                                                                                                                                                                                                                                                                                                                                                                                                          FullImportOptions
                                                                                                                                                                                                                                                                                                                                                                                                                          FullRealmExportInterface
                                                                                                                                                                                                                                                                                                                                                                                                                          FullService
                                                                                                                                                                                                                                                                                                                                                                                                                          IdObjectSkeletonInterface
                                                                                                                                                                                                                                                                                                                                                                                                                          InnerNodeRefSkeletonInterface
                                                                                                                                                                                                                                                                                                                                                                                                                          InternalRoleExportInterface
                                                                                                                                                                                                                                                                                                                                                                                                                          JwkInterface
                                                                                                                                                                                                                                                                                                                                                                                                                          JwksInterface
                                                                                                                                                                                                                                                                                                                                                                                                                          MappingExportInterface
                                                                                                                                                                                                                                                                                                                                                                                                                          MappingExportOptions
                                                                                                                                                                                                                                                                                                                                                                                                                          MappingImportOptions
                                                                                                                                                                                                                                                                                                                                                                                                                          MultiTreeExportInterface
                                                                                                                                                                                                                                                                                                                                                                                                                          NodeExportInterface
                                                                                                                                                                                                                                                                                                                                                                                                                          NodeRefSkeletonInterface
                                                                                                                                                                                                                                                                                                                                                                                                                          NoIdObjectSkeletonInterface
                                                                                                                                                                                                                                                                                                                                                                                                                          OAuth2ClientExportInterface
                                                                                                                                                                                                                                                                                                                                                                                                                          OAuth2ClientExportOptions
                                                                                                                                                                                                                                                                                                                                                                                                                          OAuth2ClientImportOptions
                                                                                                                                                                                                                                                                                                                                                                                                                          OAuth2TrustedJwtIssuerExportInterface
                                                                                                                                                                                                                                                                                                                                                                                                                          OAuth2TrustedJwtIssuerExportOptions
                                                                                                                                                                                                                                                                                                                                                                                                                          OAuth2TrustedJwtIssuerImportOptions
                                                                                                                                                                                                                                                                                                                                                                                                                          PatchOperationInterface
                                                                                                                                                                                                                                                                                                                                                                                                                          PlatformInfoInterface
                                                                                                                                                                                                                                                                                                                                                                                                                          PolicyExportInterface
                                                                                                                                                                                                                                                                                                                                                                                                                          PolicyExportOptions
                                                                                                                                                                                                                                                                                                                                                                                                                          PolicyImportOptions
                                                                                                                                                                                                                                                                                                                                                                                                                          PolicySetExportInterface
                                                                                                                                                                                                                                                                                                                                                                                                                          PolicySetExportOptions
                                                                                                                                                                                                                                                                                                                                                                                                                          PolicySetImportOptions
                                                                                                                                                                                                                                                                                                                                                                                                                          RawExportOptions
                                                                                                                                                                                                                                                                                                                                                                                                                          RealmExportInterface
                                                                                                                                                                                                                                                                                                                                                                                                                          ResourceTypeExportInterface
                                                                                                                                                                                                                                                                                                                                                                                                                          Saml2EntitiesExportOptions
                                                                                                                                                                                                                                                                                                                                                                                                                          Saml2EntitiesImportOptions
                                                                                                                                                                                                                                                                                                                                                                                                                          Saml2ExportInterface
                                                                                                                                                                                                                                                                                                                                                                                                                          ScriptExportInterface
                                                                                                                                                                                                                                                                                                                                                                                                                          ScriptExportOptions
                                                                                                                                                                                                                                                                                                                                                                                                                          ScriptImportOptions
                                                                                                                                                                                                                                                                                                                                                                                                                          ScriptTypeExportInterface
                                                                                                                                                                                                                                                                                                                                                                                                                          SecretsExportInterface
                                                                                                                                                                                                                                                                                                                                                                                                                          SecretStoreExportInterface
                                                                                                                                                                                                                                                                                                                                                                                                                          SecureConnectionProfileInterface
                                                                                                                                                                                                                                                                                                                                                                                                                          ServerExportInterface
                                                                                                                                                                                                                                                                                                                                                                                                                          ServerExportOptions
                                                                                                                                                                                                                                                                                                                                                                                                                          ServerImportOptions
                                                                                                                                                                                                                                                                                                                                                                                                                          ServiceExportInterface
                                                                                                                                                                                                                                                                                                                                                                                                                          ServiceImportOptions
                                                                                                                                                                                                                                                                                                                                                                                                                          ServiceNextDescendent
                                                                                                                                                                                                                                                                                                                                                                                                                          SingleTreeExportInterface
                                                                                                                                                                                                                                                                                                                                                                                                                          SiteExportInterface
                                                                                                                                                                                                                                                                                                                                                                                                                          SocialIdentityProviderExportOptions
                                                                                                                                                                                                                                                                                                                                                                                                                          SocialIdentityProviderImportOptions
                                                                                                                                                                                                                                                                                                                                                                                                                          SocialProviderExportInterface
                                                                                                                                                                                                                                                                                                                                                                                                                          StateInterface
                                                                                                                                                                                                                                                                                                                                                                                                                          SystemObjectPatchOperationInterface
                                                                                                                                                                                                                                                                                                                                                                                                                          SystemStatusInterface
                                                                                                                                                                                                                                                                                                                                                                                                                          ThemeExportInterface
                                                                                                                                                                                                                                                                                                                                                                                                                          TokenCacheInterface
                                                                                                                                                                                                                                                                                                                                                                                                                          TreeDependencyMapInterface
                                                                                                                                                                                                                                                                                                                                                                                                                          TreeExportOptions
                                                                                                                                                                                                                                                                                                                                                                                                                          TreeExportResolverInterface
                                                                                                                                                                                                                                                                                                                                                                                                                          TreeImportOptions
                                                                                                                                                                                                                                                                                                                                                                                                                          UiConfigInterface
                                                                                                                                                                                                                                                                                                                                                                                                                          Updates
                                                                                                                                                                                                                                                                                                                                                                                                                          UserExportInterface
                                                                                                                                                                                                                                                                                                                                                                                                                          UserGroupExportInterface
                                                                                                                                                                                                                                                                                                                                                                                                                          VariablesExportInterface

                                                                                                                                                                                                                                                                                                                                                                                                                          Type Aliases

                                                                                                                                                                                                                                                                                                                                                                                                                          AccessTokenMetaType
                                                                                                                                                                                                                                                                                                                                                                                                                          AccessTokenResponseType
                                                                                                                                                                                                                                                                                                                                                                                                                          Admin
                                                                                                                                                                                                                                                                                                                                                                                                                          AdminFederation
                                                                                                                                                                                                                                                                                                                                                                                                                          AdminFederationConfigSkeleton
                                                                                                                                                                                                                                                                                                                                                                                                                          Agent
                                                                                                                                                                                                                                                                                                                                                                                                                          AgentGroupSkeleton
                                                                                                                                                                                                                                                                                                                                                                                                                          AgentSkeleton
                                                                                                                                                                                                                                                                                                                                                                                                                          AgentType
                                                                                                                                                                                                                                                                                                                                                                                                                          AllFlag
                                                                                                                                                                                                                                                                                                                                                                                                                          AllowDuplicatesFlag
                                                                                                                                                                                                                                                                                                                                                                                                                          AmConfig
                                                                                                                                                                                                                                                                                                                                                                                                                          AmServiceSkeleton
                                                                                                                                                                                                                                                                                                                                                                                                                          ApiFactory
                                                                                                                                                                                                                                                                                                                                                                                                                          ApiVersion
                                                                                                                                                                                                                                                                                                                                                                                                                          Application
                                                                                                                                                                                                                                                                                                                                                                                                                          ApplicationExportOptions
                                                                                                                                                                                                                                                                                                                                                                                                                          ApplicationImportOptions
                                                                                                                                                                                                                                                                                                                                                                                                                          ApplicationSkeleton
                                                                                                                                                                                                                                                                                                                                                                                                                          Authenticate
                                                                                                                                                                                                                                                                                                                                                                                                                          AuthenticateSuccessResponse
                                                                                                                                                                                                                                                                                                                                                                                                                          AuthenticationSettings
                                                                                                                                                                                                                                                                                                                                                                                                                          AuthenticationSettingsSkeleton
                                                                                                                                                                                                                                                                                                                                                                                                                          Base64
                                                                                                                                                                                                                                                                                                                                                                                                                          Callback
                                                                                                                                                                                                                                                                                                                                                                                                                          CallbackHandler
                                                                                                                                                                                                                                                                                                                                                                                                                          CallbackKeyValuePair
                                                                                                                                                                                                                                                                                                                                                                                                                          CallbackType
                                                                                                                                                                                                                                                                                                                                                                                                                          CertificateResponse
                                                                                                                                                                                                                                                                                                                                                                                                                          CircleOfTrustSkeleton
                                                                                                                                                                                                                                                                                                                                                                                                                          CirclesOfTrust
                                                                                                                                                                                                                                                                                                                                                                                                                          Config
                                                                                                                                                                                                                                                                                                                                                                                                                          ConfigSkeleton
                                                                                                                                                                                                                                                                                                                                                                                                                          ConnectionProfile
                                                                                                                                                                                                                                                                                                                                                                                                                          Connector
                                                                                                                                                                                                                                                                                                                                                                                                                          ConnectorSkeleton
                                                                                                                                                                                                                                                                                                                                                                                                                          Constants
                                                                                                                                                                                                                                                                                                                                                                                                                          ContentSecurityPolicy
                                                                                                                                                                                                                                                                                                                                                                                                                          CookieDomains
                                                                                                                                                                                                                                                                                                                                                                                                                          CSR
                                                                                                                                                                                                                                                                                                                                                                                                                          CSRResponse
                                                                                                                                                                                                                                                                                                                                                                                                                          CustomDomains
                                                                                                                                                                                                                                                                                                                                                                                                                          CustomNodeProperty
                                                                                                                                                                                                                                                                                                                                                                                                                          CustomNodeSkeleton
                                                                                                                                                                                                                                                                                                                                                                                                                          CustomNodeUsage
                                                                                                                                                                                                                                                                                                                                                                                                                          DeleteJourneysStatus
                                                                                                                                                                                                                                                                                                                                                                                                                          DeleteJourneyStatus
                                                                                                                                                                                                                                                                                                                                                                                                                          DirectiveEnabled
                                                                                                                                                                                                                                                                                                                                                                                                                          DirectiveFlag
                                                                                                                                                                                                                                                                                                                                                                                                                          DirectiveSource
                                                                                                                                                                                                                                                                                                                                                                                                                          DirectiveSourceFlag
                                                                                                                                                                                                                                                                                                                                                                                                                          EmailTemplate
                                                                                                                                                                                                                                                                                                                                                                                                                          EmailTemplateSkeleton
                                                                                                                                                                                                                                                                                                                                                                                                                          EngineConfigurationSkeleton
                                                                                                                                                                                                                                                                                                                                                                                                                          EntityType
                                                                                                                                                                                                                                                                                                                                                                                                                          EnvCertificate
                                                                                                                                                                                                                                                                                                                                                                                                                          EnvContentSecurityPolicy
                                                                                                                                                                                                                                                                                                                                                                                                                          EnvCookieDomains
                                                                                                                                                                                                                                                                                                                                                                                                                          EnvCSR
                                                                                                                                                                                                                                                                                                                                                                                                                          EnvCustomDomains
                                                                                                                                                                                                                                                                                                                                                                                                                          EnvFederationEnforcement
                                                                                                                                                                                                                                                                                                                                                                                                                          EnvironmentAndSystemPropertySecretStoreSkeleton
                                                                                                                                                                                                                                                                                                                                                                                                                          EnvPromotion
                                                                                                                                                                                                                                                                                                                                                                                                                          EnvRelease
                                                                                                                                                                                                                                                                                                                                                                                                                          EnvServiceAccountScopes
                                                                                                                                                                                                                                                                                                                                                                                                                          EnvSSOCookieConfig
                                                                                                                                                                                                                                                                                                                                                                                                                          EsvCount
                                                                                                                                                                                                                                                                                                                                                                                                                          EsvCountResponse
                                                                                                                                                                                                                                                                                                                                                                                                                          ExportImport
                                                                                                                                                                                                                                                                                                                                                                                                                          Feature
                                                                                                                                                                                                                                                                                                                                                                                                                          FederationEnforcement
                                                                                                                                                                                                                                                                                                                                                                                                                          FileSystemSecretStoreSkeleton
                                                                                                                                                                                                                                                                                                                                                                                                                          Frodo
                                                                                                                                                                                                                                                                                                                                                                                                                          FrodoCrypto
                                                                                                                                                                                                                                                                                                                                                                                                                          FRUtils
                                                                                                                                                                                                                                                                                                                                                                                                                          GatewayAgentType
                                                                                                                                                                                                                                                                                                                                                                                                                          GoogleKeyManagementServiceSecretStoreSkeleton
                                                                                                                                                                                                                                                                                                                                                                                                                          GoogleSecretManagerSecretStoreProviderSkeleton
                                                                                                                                                                                                                                                                                                                                                                                                                          HsmSecretStoreSkeleton
                                                                                                                                                                                                                                                                                                                                                                                                                          IdmConfig
                                                                                                                                                                                                                                                                                                                                                                                                                          IdmConfigStub
                                                                                                                                                                                                                                                                                                                                                                                                                          IdmCrypto
                                                                                                                                                                                                                                                                                                                                                                                                                          IdmScript
                                                                                                                                                                                                                                                                                                                                                                                                                          IdmSystem
                                                                                                                                                                                                                                                                                                                                                                                                                          Idp
                                                                                                                                                                                                                                                                                                                                                                                                                          Info
                                                                                                                                                                                                                                                                                                                                                                                                                          InternalRole
                                                                                                                                                                                                                                                                                                                                                                                                                          InternalRoleSkeleton
                                                                                                                                                                                                                                                                                                                                                                                                                          JavaAgentType
                                                                                                                                                                                                                                                                                                                                                                                                                          Jose
                                                                                                                                                                                                                                                                                                                                                                                                                          Journey
                                                                                                                                                                                                                                                                                                                                                                                                                          JourneyClassificationType
                                                                                                                                                                                                                                                                                                                                                                                                                          Json
                                                                                                                                                                                                                                                                                                                                                                                                                          JwkRsa
                                                                                                                                                                                                                                                                                                                                                                                                                          JwkRsaPublic
                                                                                                                                                                                                                                                                                                                                                                                                                          KeyStoreSecretStoreSkeleton
                                                                                                                                                                                                                                                                                                                                                                                                                          LockResponse
                                                                                                                                                                                                                                                                                                                                                                                                                          LockStatus
                                                                                                                                                                                                                                                                                                                                                                                                                          Log
                                                                                                                                                                                                                                                                                                                                                                                                                          LogApiKey
                                                                                                                                                                                                                                                                                                                                                                                                                          LogEventPayloadSkeleton
                                                                                                                                                                                                                                                                                                                                                                                                                          LogEventSkeleton
                                                                                                                                                                                                                                                                                                                                                                                                                          ManagedObject
                                                                                                                                                                                                                                                                                                                                                                                                                          Mapping
                                                                                                                                                                                                                                                                                                                                                                                                                          MappingPolicy
                                                                                                                                                                                                                                                                                                                                                                                                                          MappingProperty
                                                                                                                                                                                                                                                                                                                                                                                                                          MappingSkeleton
                                                                                                                                                                                                                                                                                                                                                                                                                          Node
                                                                                                                                                                                                                                                                                                                                                                                                                          NodeClassificationType
                                                                                                                                                                                                                                                                                                                                                                                                                          NodeSkeleton
                                                                                                                                                                                                                                                                                                                                                                                                                          NoneFlag
                                                                                                                                                                                                                                                                                                                                                                                                                          OAuth2Client
                                                                                                                                                                                                                                                                                                                                                                                                                          OAuth2ClientSkeleton
                                                                                                                                                                                                                                                                                                                                                                                                                          OAuth2Oidc
                                                                                                                                                                                                                                                                                                                                                                                                                          OAuth2Provider
                                                                                                                                                                                                                                                                                                                                                                                                                          OAuth2ProviderSkeleton
                                                                                                                                                                                                                                                                                                                                                                                                                          OAuth2ThingType
                                                                                                                                                                                                                                                                                                                                                                                                                          OAuth2TrustedJwtIssuer
                                                                                                                                                                                                                                                                                                                                                                                                                          OAuth2TrustedJwtIssuerSkeleton
                                                                                                                                                                                                                                                                                                                                                                                                                          ObjectPropertyFlag
                                                                                                                                                                                                                                                                                                                                                                                                                          ObjectPropertyNativeType
                                                                                                                                                                                                                                                                                                                                                                                                                          ObjectPropertySkeleton
                                                                                                                                                                                                                                                                                                                                                                                                                          ObjectPropertyType
                                                                                                                                                                                                                                                                                                                                                                                                                          ObjectTypeSkeleton
                                                                                                                                                                                                                                                                                                                                                                                                                          Organization
                                                                                                                                                                                                                                                                                                                                                                                                                          PagedResult
                                                                                                                                                                                                                                                                                                                                                                                                                          PlatformInfo
                                                                                                                                                                                                                                                                                                                                                                                                                          Policy
                                                                                                                                                                                                                                                                                                                                                                                                                          PolicyAgentType
                                                                                                                                                                                                                                                                                                                                                                                                                          PolicyCondition
                                                                                                                                                                                                                                                                                                                                                                                                                          PolicyConditionType
                                                                                                                                                                                                                                                                                                                                                                                                                          PolicySet
                                                                                                                                                                                                                                                                                                                                                                                                                          PolicySetSkeleton
                                                                                                                                                                                                                                                                                                                                                                                                                          PolicySkeleton
                                                                                                                                                                                                                                                                                                                                                                                                                          ProgressIndicatorStatusType
                                                                                                                                                                                                                                                                                                                                                                                                                          ProgressIndicatorType
                                                                                                                                                                                                                                                                                                                                                                                                                          PromotionConfig
                                                                                                                                                                                                                                                                                                                                                                                                                          PromotionConfigChange
                                                                                                                                                                                                                                                                                                                                                                                                                          PromotionReport
                                                                                                                                                                                                                                                                                                                                                                                                                          PromotionReportStub
                                                                                                                                                                                                                                                                                                                                                                                                                          PromotionRequestConfig
                                                                                                                                                                                                                                                                                                                                                                                                                          PromotionResponse
                                                                                                                                                                                                                                                                                                                                                                                                                          PromotionStatus
                                                                                                                                                                                                                                                                                                                                                                                                                          PromotionType
                                                                                                                                                                                                                                                                                                                                                                                                                          RawConfig
                                                                                                                                                                                                                                                                                                                                                                                                                          Readable
                                                                                                                                                                                                                                                                                                                                                                                                                          Realm
                                                                                                                                                                                                                                                                                                                                                                                                                          RealmSkeleton
                                                                                                                                                                                                                                                                                                                                                                                                                          Recon
                                                                                                                                                                                                                                                                                                                                                                                                                          ReconStatusType
                                                                                                                                                                                                                                                                                                                                                                                                                          ReconType
                                                                                                                                                                                                                                                                                                                                                                                                                          RefererDirectiveFlag
                                                                                                                                                                                                                                                                                                                                                                                                                          Release
                                                                                                                                                                                                                                                                                                                                                                                                                          RemoteConsentAgentType
                                                                                                                                                                                                                                                                                                                                                                                                                          ResourceConfig
                                                                                                                                                                                                                                                                                                                                                                                                                          ResourceType
                                                                                                                                                                                                                                                                                                                                                                                                                          ResourceTypeSkeleton
                                                                                                                                                                                                                                                                                                                                                                                                                          ResultCallback
                                                                                                                                                                                                                                                                                                                                                                                                                          RetryEverythingStrategy
                                                                                                                                                                                                                                                                                                                                                                                                                          RetryNetworkStrategy
                                                                                                                                                                                                                                                                                                                                                                                                                          RetryNothingStrategy
                                                                                                                                                                                                                                                                                                                                                                                                                          RetryStrategy
                                                                                                                                                                                                                                                                                                                                                                                                                          RollbackConfig
                                                                                                                                                                                                                                                                                                                                                                                                                          RollbackResponse
                                                                                                                                                                                                                                                                                                                                                                                                                          Saml2
                                                                                                                                                                                                                                                                                                                                                                                                                          Saml2ProiderLocation
                                                                                                                                                                                                                                                                                                                                                                                                                          Saml2ProviderSkeleton
                                                                                                                                                                                                                                                                                                                                                                                                                          Saml2ProviderStub
                                                                                                                                                                                                                                                                                                                                                                                                                          SandboxDirectiveFlag
                                                                                                                                                                                                                                                                                                                                                                                                                          Script
                                                                                                                                                                                                                                                                                                                                                                                                                          ScriptContext
                                                                                                                                                                                                                                                                                                                                                                                                                          ScriptFlag
                                                                                                                                                                                                                                                                                                                                                                                                                          ScriptingContextSkeleton
                                                                                                                                                                                                                                                                                                                                                                                                                          ScriptLanguage
                                                                                                                                                                                                                                                                                                                                                                                                                          ScriptSkeleton
                                                                                                                                                                                                                                                                                                                                                                                                                          ScriptType
                                                                                                                                                                                                                                                                                                                                                                                                                          ScriptTypeExportSkeleton
                                                                                                                                                                                                                                                                                                                                                                                                                          ScriptTypeSkeleton
                                                                                                                                                                                                                                                                                                                                                                                                                          ScriptValidation
                                                                                                                                                                                                                                                                                                                                                                                                                          Secret
                                                                                                                                                                                                                                                                                                                                                                                                                          SecretEncodingType

                                                                                                                                                                                                                                                                                                                                                                                                                          You can use the encoding parameter to set an encoding format when you create an ESV secret. You can only choose an encoding format using the API. The UI currently creates secrets only with the generic encoding format.

                                                                                                                                                                                                                                                                                                                                                                                                                          SecretSkeleton
                                                                                                                                                                                                                                                                                                                                                                                                                          SecretStore
                                                                                                                                                                                                                                                                                                                                                                                                                          SecretStoreExportSkeleton
                                                                                                                                                                                                                                                                                                                                                                                                                          SecretStoreMappingSkeleton
                                                                                                                                                                                                                                                                                                                                                                                                                          SecretStoreSchemaSkeleton
                                                                                                                                                                                                                                                                                                                                                                                                                          SecretStoreSkeleton
                                                                                                                                                                                                                                                                                                                                                                                                                          SelfFlag
                                                                                                                                                                                                                                                                                                                                                                                                                          Server
                                                                                                                                                                                                                                                                                                                                                                                                                          ServerExportSkeleton
                                                                                                                                                                                                                                                                                                                                                                                                                          ServerPropertiesSkeleton
                                                                                                                                                                                                                                                                                                                                                                                                                          ServerSkeleton
                                                                                                                                                                                                                                                                                                                                                                                                                          Service
                                                                                                                                                                                                                                                                                                                                                                                                                          ServiceAccount
                                                                                                                                                                                                                                                                                                                                                                                                                          ServiceAccountScope
                                                                                                                                                                                                                                                                                                                                                                                                                          ServiceAccountType
                                                                                                                                                                                                                                                                                                                                                                                                                          Session
                                                                                                                                                                                                                                                                                                                                                                                                                          SessionInfoType
                                                                                                                                                                                                                                                                                                                                                                                                                          SharedAgentType
                                                                                                                                                                                                                                                                                                                                                                                                                          Site
                                                                                                                                                                                                                                                                                                                                                                                                                          SiteSkeleton
                                                                                                                                                                                                                                                                                                                                                                                                                          SoapSTSAgentType
                                                                                                                                                                                                                                                                                                                                                                                                                          SocialIdpSkeleton
                                                                                                                                                                                                                                                                                                                                                                                                                          SoftwarePublisherType
                                                                                                                                                                                                                                                                                                                                                                                                                          SSOCookieConfig
                                                                                                                                                                                                                                                                                                                                                                                                                          Startup
                                                                                                                                                                                                                                                                                                                                                                                                                          State
                                                                                                                                                                                                                                                                                                                                                                                                                          SyncSkeleton
                                                                                                                                                                                                                                                                                                                                                                                                                          Theme
                                                                                                                                                                                                                                                                                                                                                                                                                          ThemeSkeleton
                                                                                                                                                                                                                                                                                                                                                                                                                          TokenCache
                                                                                                                                                                                                                                                                                                                                                                                                                          TokenInfoResponseType
                                                                                                                                                                                                                                                                                                                                                                                                                          Tokens
                                                                                                                                                                                                                                                                                                                                                                                                                          tokenType
                                                                                                                                                                                                                                                                                                                                                                                                                          TreeSkeleton
                                                                                                                                                                                                                                                                                                                                                                                                                          User
                                                                                                                                                                                                                                                                                                                                                                                                                          UserConfigSkeleton
                                                                                                                                                                                                                                                                                                                                                                                                                          UserExportSkeleton
                                                                                                                                                                                                                                                                                                                                                                                                                          UserGroupSkeleton
                                                                                                                                                                                                                                                                                                                                                                                                                          UserSessionMetaType
                                                                                                                                                                                                                                                                                                                                                                                                                          UserSkeleton
                                                                                                                                                                                                                                                                                                                                                                                                                          Variable
                                                                                                                                                                                                                                                                                                                                                                                                                          VariableExpressionType

                                                                                                                                                                                                                                                                                                                                                                                                                          You can use the expressionType parameter to set a type when you create an ESV variable. @@ -11,4 +11,4 @@ {"$int": "&{esv.journey.ldap.port|1389}"}. The expressionType parameter supplements this expression level syntax and allows the ESV type to be identified without inspecting configuration.

                                                                                                                                                                                                                                                                                                                                                                                                                          -
                                                                                                                                                                                                                                                                                                                                                                                                                          VariableSkeleton
                                                                                                                                                                                                                                                                                                                                                                                                                          Version
                                                                                                                                                                                                                                                                                                                                                                                                                          VersionOfSecretSkeleton
                                                                                                                                                                                                                                                                                                                                                                                                                          VersionOfSecretStatus
                                                                                                                                                                                                                                                                                                                                                                                                                          WebAgentType
                                                                                                                                                                                                                                                                                                                                                                                                                          Writable
                                                                                                                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                                                                                                                          VariableSkeleton
                                                                                                                                                                                                                                                                                                                                                                                                                          Version
                                                                                                                                                                                                                                                                                                                                                                                                                          VersionOfSecretSkeleton
                                                                                                                                                                                                                                                                                                                                                                                                                          VersionOfSecretStatus
                                                                                                                                                                                                                                                                                                                                                                                                                          WebAgentType
                                                                                                                                                                                                                                                                                                                                                                                                                          Writable
                                                                                                                                                                                                                                                                                                                                                                                                                          diff --git a/docs/types/Reference.AccessTokenMetaType.html b/docs/types/Reference.AccessTokenMetaType.html index d5b91d744..85375f5ec 100644 --- a/docs/types/Reference.AccessTokenMetaType.html +++ b/docs/types/Reference.AccessTokenMetaType.html @@ -1 +1 @@ -AccessTokenMetaType | Frodo Library - v4.0.0-10
                                                                                                                                                                                                                                                                                                                                                                                                                          Frodo Library - v4.0.0-10
                                                                                                                                                                                                                                                                                                                                                                                                                            Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                            Type Alias AccessTokenMetaType

                                                                                                                                                                                                                                                                                                                                                                                                                            AccessTokenMetaType: AccessTokenResponseType & {
                                                                                                                                                                                                                                                                                                                                                                                                                                expires: number;
                                                                                                                                                                                                                                                                                                                                                                                                                                from_cache?: boolean;
                                                                                                                                                                                                                                                                                                                                                                                                                            }
                                                                                                                                                                                                                                                                                                                                                                                                                            +AccessTokenMetaType | Frodo Library - v4.0.0-11
                                                                                                                                                                                                                                                                                                                                                                                                                            Frodo Library - v4.0.0-11
                                                                                                                                                                                                                                                                                                                                                                                                                              Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                              Type Alias AccessTokenMetaType

                                                                                                                                                                                                                                                                                                                                                                                                                              AccessTokenMetaType: AccessTokenResponseType & {
                                                                                                                                                                                                                                                                                                                                                                                                                                  expires: number;
                                                                                                                                                                                                                                                                                                                                                                                                                                  from_cache?: boolean;
                                                                                                                                                                                                                                                                                                                                                                                                                              }
                                                                                                                                                                                                                                                                                                                                                                                                                              diff --git a/docs/types/Reference.AccessTokenResponseType.html b/docs/types/Reference.AccessTokenResponseType.html index 93dffe912..940190f1d 100644 --- a/docs/types/Reference.AccessTokenResponseType.html +++ b/docs/types/Reference.AccessTokenResponseType.html @@ -1,6 +1,6 @@ -AccessTokenResponseType | Frodo Library - v4.0.0-10
                                                                                                                                                                                                                                                                                                                                                                                                                              Frodo Library - v4.0.0-10
                                                                                                                                                                                                                                                                                                                                                                                                                                Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                                Type Alias AccessTokenResponseType

                                                                                                                                                                                                                                                                                                                                                                                                                                type AccessTokenResponseType = {
                                                                                                                                                                                                                                                                                                                                                                                                                                    access_token: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                    expires_in: number;
                                                                                                                                                                                                                                                                                                                                                                                                                                    id_token?: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                    scope: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                    token_type: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                }
                                                                                                                                                                                                                                                                                                                                                                                                                                Index

                                                                                                                                                                                                                                                                                                                                                                                                                                Properties

                                                                                                                                                                                                                                                                                                                                                                                                                                access_token +AccessTokenResponseType | Frodo Library - v4.0.0-11
                                                                                                                                                                                                                                                                                                                                                                                                                                Frodo Library - v4.0.0-11
                                                                                                                                                                                                                                                                                                                                                                                                                                  Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                                  Type Alias AccessTokenResponseType

                                                                                                                                                                                                                                                                                                                                                                                                                                  type AccessTokenResponseType = {
                                                                                                                                                                                                                                                                                                                                                                                                                                      access_token: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                      expires_in: number;
                                                                                                                                                                                                                                                                                                                                                                                                                                      id_token?: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                      scope: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                      token_type: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                  }
                                                                                                                                                                                                                                                                                                                                                                                                                                  Index

                                                                                                                                                                                                                                                                                                                                                                                                                                  Properties

                                                                                                                                                                                                                                                                                                                                                                                                                                  access_token: string
                                                                                                                                                                                                                                                                                                                                                                                                                                  expires_in: number
                                                                                                                                                                                                                                                                                                                                                                                                                                  id_token?: string
                                                                                                                                                                                                                                                                                                                                                                                                                                  scope: string
                                                                                                                                                                                                                                                                                                                                                                                                                                  token_type: string
                                                                                                                                                                                                                                                                                                                                                                                                                                  +

                                                                                                                                                                                                                                                                                                                                                                                                                                  Properties

                                                                                                                                                                                                                                                                                                                                                                                                                                  access_token: string
                                                                                                                                                                                                                                                                                                                                                                                                                                  expires_in: number
                                                                                                                                                                                                                                                                                                                                                                                                                                  id_token?: string
                                                                                                                                                                                                                                                                                                                                                                                                                                  scope: string
                                                                                                                                                                                                                                                                                                                                                                                                                                  token_type: string
                                                                                                                                                                                                                                                                                                                                                                                                                                  diff --git a/docs/types/Reference.Admin.html b/docs/types/Reference.Admin.html index d84db6b71..affb423b6 100644 --- a/docs/types/Reference.Admin.html +++ b/docs/types/Reference.Admin.html @@ -1,4 +1,4 @@ -Admin | Frodo Library - v4.0.0-10
                                                                                                                                                                                                                                                                                                                                                                                                                                  Frodo Library - v4.0.0-10
                                                                                                                                                                                                                                                                                                                                                                                                                                    Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                                    Type Alias Admin

                                                                                                                                                                                                                                                                                                                                                                                                                                    type Admin = {
                                                                                                                                                                                                                                                                                                                                                                                                                                        addAutoIdStaticUserMapping(): Promise<void>;
                                                                                                                                                                                                                                                                                                                                                                                                                                        createLongLivedToken(
                                                                                                                                                                                                                                                                                                                                                                                                                                            clientId: string,
                                                                                                                                                                                                                                                                                                                                                                                                                                            clientSecret: string,
                                                                                                                                                                                                                                                                                                                                                                                                                                            scope: string,
                                                                                                                                                                                                                                                                                                                                                                                                                                            secret: string | boolean,
                                                                                                                                                                                                                                                                                                                                                                                                                                            lifetime: number,
                                                                                                                                                                                                                                                                                                                                                                                                                                        ): Promise<any>;
                                                                                                                                                                                                                                                                                                                                                                                                                                        createOAuth2ClientWithAdminPrivileges(
                                                                                                                                                                                                                                                                                                                                                                                                                                            clientId: string,
                                                                                                                                                                                                                                                                                                                                                                                                                                            clientSecret: string,
                                                                                                                                                                                                                                                                                                                                                                                                                                        ): Promise<void>;
                                                                                                                                                                                                                                                                                                                                                                                                                                        executeRfc7523AuthZGrantFlow(
                                                                                                                                                                                                                                                                                                                                                                                                                                            clientId: string,
                                                                                                                                                                                                                                                                                                                                                                                                                                            iss: string,
                                                                                                                                                                                                                                                                                                                                                                                                                                            jwk: JwkRsa,
                                                                                                                                                                                                                                                                                                                                                                                                                                            sub: string,
                                                                                                                                                                                                                                                                                                                                                                                                                                            scope?: string[],
                                                                                                                                                                                                                                                                                                                                                                                                                                        ): Promise<AccessTokenResponseType>;
                                                                                                                                                                                                                                                                                                                                                                                                                                        generateRfc7523AuthZGrantArtefacts(
                                                                                                                                                                                                                                                                                                                                                                                                                                            clientId: string,
                                                                                                                                                                                                                                                                                                                                                                                                                                            iss: string,
                                                                                                                                                                                                                                                                                                                                                                                                                                            jwk?: JwkRsa,
                                                                                                                                                                                                                                                                                                                                                                                                                                            sub?: string,
                                                                                                                                                                                                                                                                                                                                                                                                                                            scope?: string[],
                                                                                                                                                                                                                                                                                                                                                                                                                                            options?: { save: boolean },
                                                                                                                                                                                                                                                                                                                                                                                                                                        ): Promise<
                                                                                                                                                                                                                                                                                                                                                                                                                                            {
                                                                                                                                                                                                                                                                                                                                                                                                                                                client: OAuth2ClientSkeleton;
                                                                                                                                                                                                                                                                                                                                                                                                                                                issuer: OAuth2TrustedJwtIssuerSkeleton;
                                                                                                                                                                                                                                                                                                                                                                                                                                                jwk: JwkRsa;
                                                                                                                                                                                                                                                                                                                                                                                                                                                jwks: JwksInterface;
                                                                                                                                                                                                                                                                                                                                                                                                                                            },
                                                                                                                                                                                                                                                                                                                                                                                                                                        >;
                                                                                                                                                                                                                                                                                                                                                                                                                                        generateRfc7523ClientAuthNArtefacts(
                                                                                                                                                                                                                                                                                                                                                                                                                                            clientId: string,
                                                                                                                                                                                                                                                                                                                                                                                                                                            aud?: string,
                                                                                                                                                                                                                                                                                                                                                                                                                                            jwk?: JwkRsa,
                                                                                                                                                                                                                                                                                                                                                                                                                                            options?: { save: boolean },
                                                                                                                                                                                                                                                                                                                                                                                                                                        ): Promise<
                                                                                                                                                                                                                                                                                                                                                                                                                                            {
                                                                                                                                                                                                                                                                                                                                                                                                                                                client: OAuth2ClientSkeleton;
                                                                                                                                                                                                                                                                                                                                                                                                                                                jwk: JwkRsa;
                                                                                                                                                                                                                                                                                                                                                                                                                                                jwks: JwksInterface;
                                                                                                                                                                                                                                                                                                                                                                                                                                                jwt: any;
                                                                                                                                                                                                                                                                                                                                                                                                                                            },
                                                                                                                                                                                                                                                                                                                                                                                                                                        >;
                                                                                                                                                                                                                                                                                                                                                                                                                                        grantOAuth2ClientAdminPrivileges(clientId: string): Promise<void>;
                                                                                                                                                                                                                                                                                                                                                                                                                                        hideGenericExtensionAttributes(
                                                                                                                                                                                                                                                                                                                                                                                                                                            includeCustomized: boolean,
                                                                                                                                                                                                                                                                                                                                                                                                                                            dryRun: boolean,
                                                                                                                                                                                                                                                                                                                                                                                                                                        ): Promise<void>;
                                                                                                                                                                                                                                                                                                                                                                                                                                        listNonOAuth2AdminStaticUserMappings(
                                                                                                                                                                                                                                                                                                                                                                                                                                            showProtected: boolean,
                                                                                                                                                                                                                                                                                                                                                                                                                                        ): Promise<string[]>;
                                                                                                                                                                                                                                                                                                                                                                                                                                        listOAuth2AdminClients(): Promise<string[]>;
                                                                                                                                                                                                                                                                                                                                                                                                                                        listOAuth2CustomClients(): Promise<string[]>;
                                                                                                                                                                                                                                                                                                                                                                                                                                        removeStaticUserMapping(subject: string): Promise<void>;
                                                                                                                                                                                                                                                                                                                                                                                                                                        repairOrgModel(
                                                                                                                                                                                                                                                                                                                                                                                                                                            excludeCustomized: boolean,
                                                                                                                                                                                                                                                                                                                                                                                                                                            extendPermissions: boolean,
                                                                                                                                                                                                                                                                                                                                                                                                                                            dryRun: boolean,
                                                                                                                                                                                                                                                                                                                                                                                                                                        ): Promise<void>;
                                                                                                                                                                                                                                                                                                                                                                                                                                        revokeOAuth2ClientAdminPrivileges(clientId: string): Promise<void>;
                                                                                                                                                                                                                                                                                                                                                                                                                                        showGenericExtensionAttributes(
                                                                                                                                                                                                                                                                                                                                                                                                                                            includeCustomized: boolean,
                                                                                                                                                                                                                                                                                                                                                                                                                                            dryRun: boolean,
                                                                                                                                                                                                                                                                                                                                                                                                                                        ): Promise<void>;
                                                                                                                                                                                                                                                                                                                                                                                                                                        trainAA(
                                                                                                                                                                                                                                                                                                                                                                                                                                            apiKey: string,
                                                                                                                                                                                                                                                                                                                                                                                                                                            apiSecret: string,
                                                                                                                                                                                                                                                                                                                                                                                                                                            customUsernames?: string[],
                                                                                                                                                                                                                                                                                                                                                                                                                                            customUserAgents?: string[],
                                                                                                                                                                                                                                                                                                                                                                                                                                            customIPs?: string[],
                                                                                                                                                                                                                                                                                                                                                                                                                                            loginsPerUser?: number,
                                                                                                                                                                                                                                                                                                                                                                                                                                            service?: string,
                                                                                                                                                                                                                                                                                                                                                                                                                                        ): Promise<void>;
                                                                                                                                                                                                                                                                                                                                                                                                                                    }
                                                                                                                                                                                                                                                                                                                                                                                                                                    Index

                                                                                                                                                                                                                                                                                                                                                                                                                                    Methods

                                                                                                                                                                                                                                                                                                                                                                                                                                    executeRfc7523AuthZGrantFlow +Admin | Frodo Library - v4.0.0-11
                                                                                                                                                                                                                                                                                                                                                                                                                                    Frodo Library - v4.0.0-11
                                                                                                                                                                                                                                                                                                                                                                                                                                      Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                                      Type Alias Admin

                                                                                                                                                                                                                                                                                                                                                                                                                                      type Admin = {
                                                                                                                                                                                                                                                                                                                                                                                                                                          addAutoIdStaticUserMapping(): Promise<void>;
                                                                                                                                                                                                                                                                                                                                                                                                                                          createLongLivedToken(
                                                                                                                                                                                                                                                                                                                                                                                                                                              clientId: string,
                                                                                                                                                                                                                                                                                                                                                                                                                                              clientSecret: string,
                                                                                                                                                                                                                                                                                                                                                                                                                                              scope: string,
                                                                                                                                                                                                                                                                                                                                                                                                                                              secret: string | boolean,
                                                                                                                                                                                                                                                                                                                                                                                                                                              lifetime: number,
                                                                                                                                                                                                                                                                                                                                                                                                                                          ): Promise<any>;
                                                                                                                                                                                                                                                                                                                                                                                                                                          createOAuth2ClientWithAdminPrivileges(
                                                                                                                                                                                                                                                                                                                                                                                                                                              clientId: string,
                                                                                                                                                                                                                                                                                                                                                                                                                                              clientSecret: string,
                                                                                                                                                                                                                                                                                                                                                                                                                                          ): Promise<void>;
                                                                                                                                                                                                                                                                                                                                                                                                                                          executeRfc7523AuthZGrantFlow(
                                                                                                                                                                                                                                                                                                                                                                                                                                              clientId: string,
                                                                                                                                                                                                                                                                                                                                                                                                                                              iss: string,
                                                                                                                                                                                                                                                                                                                                                                                                                                              jwk: JwkRsa,
                                                                                                                                                                                                                                                                                                                                                                                                                                              sub: string,
                                                                                                                                                                                                                                                                                                                                                                                                                                              scope?: string[],
                                                                                                                                                                                                                                                                                                                                                                                                                                          ): Promise<AccessTokenResponseType>;
                                                                                                                                                                                                                                                                                                                                                                                                                                          generateRfc7523AuthZGrantArtefacts(
                                                                                                                                                                                                                                                                                                                                                                                                                                              clientId: string,
                                                                                                                                                                                                                                                                                                                                                                                                                                              iss: string,
                                                                                                                                                                                                                                                                                                                                                                                                                                              jwk?: JwkRsa,
                                                                                                                                                                                                                                                                                                                                                                                                                                              sub?: string,
                                                                                                                                                                                                                                                                                                                                                                                                                                              scope?: string[],
                                                                                                                                                                                                                                                                                                                                                                                                                                              options?: { save: boolean },
                                                                                                                                                                                                                                                                                                                                                                                                                                          ): Promise<
                                                                                                                                                                                                                                                                                                                                                                                                                                              {
                                                                                                                                                                                                                                                                                                                                                                                                                                                  client: OAuth2ClientSkeleton;
                                                                                                                                                                                                                                                                                                                                                                                                                                                  issuer: OAuth2TrustedJwtIssuerSkeleton;
                                                                                                                                                                                                                                                                                                                                                                                                                                                  jwk: JwkRsa;
                                                                                                                                                                                                                                                                                                                                                                                                                                                  jwks: JwksInterface;
                                                                                                                                                                                                                                                                                                                                                                                                                                              },
                                                                                                                                                                                                                                                                                                                                                                                                                                          >;
                                                                                                                                                                                                                                                                                                                                                                                                                                          generateRfc7523ClientAuthNArtefacts(
                                                                                                                                                                                                                                                                                                                                                                                                                                              clientId: string,
                                                                                                                                                                                                                                                                                                                                                                                                                                              aud?: string,
                                                                                                                                                                                                                                                                                                                                                                                                                                              jwk?: JwkRsa,
                                                                                                                                                                                                                                                                                                                                                                                                                                              options?: { save: boolean },
                                                                                                                                                                                                                                                                                                                                                                                                                                          ): Promise<
                                                                                                                                                                                                                                                                                                                                                                                                                                              {
                                                                                                                                                                                                                                                                                                                                                                                                                                                  client: OAuth2ClientSkeleton;
                                                                                                                                                                                                                                                                                                                                                                                                                                                  jwk: JwkRsa;
                                                                                                                                                                                                                                                                                                                                                                                                                                                  jwks: JwksInterface;
                                                                                                                                                                                                                                                                                                                                                                                                                                                  jwt: any;
                                                                                                                                                                                                                                                                                                                                                                                                                                              },
                                                                                                                                                                                                                                                                                                                                                                                                                                          >;
                                                                                                                                                                                                                                                                                                                                                                                                                                          grantOAuth2ClientAdminPrivileges(clientId: string): Promise<void>;
                                                                                                                                                                                                                                                                                                                                                                                                                                          hideGenericExtensionAttributes(
                                                                                                                                                                                                                                                                                                                                                                                                                                              includeCustomized: boolean,
                                                                                                                                                                                                                                                                                                                                                                                                                                              dryRun: boolean,
                                                                                                                                                                                                                                                                                                                                                                                                                                          ): Promise<void>;
                                                                                                                                                                                                                                                                                                                                                                                                                                          listNonOAuth2AdminStaticUserMappings(
                                                                                                                                                                                                                                                                                                                                                                                                                                              showProtected: boolean,
                                                                                                                                                                                                                                                                                                                                                                                                                                          ): Promise<string[]>;
                                                                                                                                                                                                                                                                                                                                                                                                                                          listOAuth2AdminClients(): Promise<string[]>;
                                                                                                                                                                                                                                                                                                                                                                                                                                          listOAuth2CustomClients(): Promise<string[]>;
                                                                                                                                                                                                                                                                                                                                                                                                                                          removeStaticUserMapping(subject: string): Promise<void>;
                                                                                                                                                                                                                                                                                                                                                                                                                                          repairOrgModel(
                                                                                                                                                                                                                                                                                                                                                                                                                                              excludeCustomized: boolean,
                                                                                                                                                                                                                                                                                                                                                                                                                                              extendPermissions: boolean,
                                                                                                                                                                                                                                                                                                                                                                                                                                              dryRun: boolean,
                                                                                                                                                                                                                                                                                                                                                                                                                                          ): Promise<void>;
                                                                                                                                                                                                                                                                                                                                                                                                                                          revokeOAuth2ClientAdminPrivileges(clientId: string): Promise<void>;
                                                                                                                                                                                                                                                                                                                                                                                                                                          showGenericExtensionAttributes(
                                                                                                                                                                                                                                                                                                                                                                                                                                              includeCustomized: boolean,
                                                                                                                                                                                                                                                                                                                                                                                                                                              dryRun: boolean,
                                                                                                                                                                                                                                                                                                                                                                                                                                          ): Promise<void>;
                                                                                                                                                                                                                                                                                                                                                                                                                                          trainAA(
                                                                                                                                                                                                                                                                                                                                                                                                                                              apiKey: string,
                                                                                                                                                                                                                                                                                                                                                                                                                                              apiSecret: string,
                                                                                                                                                                                                                                                                                                                                                                                                                                              customUsernames?: string[],
                                                                                                                                                                                                                                                                                                                                                                                                                                              customUserAgents?: string[],
                                                                                                                                                                                                                                                                                                                                                                                                                                              customIPs?: string[],
                                                                                                                                                                                                                                                                                                                                                                                                                                              loginsPerUser?: number,
                                                                                                                                                                                                                                                                                                                                                                                                                                              service?: string,
                                                                                                                                                                                                                                                                                                                                                                                                                                          ): Promise<void>;
                                                                                                                                                                                                                                                                                                                                                                                                                                      }
                                                                                                                                                                                                                                                                                                                                                                                                                                      Index

                                                                                                                                                                                                                                                                                                                                                                                                                                      Methods

                                                                                                                                                                                                                                                                                                                                                                                                                                      • Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                        • clientId: string
                                                                                                                                                                                                                                                                                                                                                                                                                                        • Optionalaud: string
                                                                                                                                                                                                                                                                                                                                                                                                                                        • Optionaljwk: JwkRsa
                                                                                                                                                                                                                                                                                                                                                                                                                                        • Optionaloptions: { save: boolean }

                                                                                                                                                                                                                                                                                                                                                                                                                                        Returns Promise<
                                                                                                                                                                                                                                                                                                                                                                                                                                            {
                                                                                                                                                                                                                                                                                                                                                                                                                                                client: OAuth2ClientSkeleton;
                                                                                                                                                                                                                                                                                                                                                                                                                                                jwk: JwkRsa;
                                                                                                                                                                                                                                                                                                                                                                                                                                                jwks: JwksInterface;
                                                                                                                                                                                                                                                                                                                                                                                                                                                jwt: any;
                                                                                                                                                                                                                                                                                                                                                                                                                                            },
                                                                                                                                                                                                                                                                                                                                                                                                                                        >

                                                                                                                                                                                                                                                                                                                                                                                                                                      • Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                        • apiKey: string
                                                                                                                                                                                                                                                                                                                                                                                                                                        • apiSecret: string
                                                                                                                                                                                                                                                                                                                                                                                                                                        • OptionalcustomUsernames: string[]
                                                                                                                                                                                                                                                                                                                                                                                                                                        • OptionalcustomUserAgents: string[]
                                                                                                                                                                                                                                                                                                                                                                                                                                        • OptionalcustomIPs: string[]
                                                                                                                                                                                                                                                                                                                                                                                                                                        • OptionalloginsPerUser: number
                                                                                                                                                                                                                                                                                                                                                                                                                                        • Optionalservice: string

                                                                                                                                                                                                                                                                                                                                                                                                                                        Returns Promise<void>

                                                                                                                                                                                                                                                                                                                                                                                                                                      Deprecated

                                                                                                                                                                                                                                                                                                                                                                                                                                      • Returns Promise<void>

                                                                                                                                                                                                                                                                                                                                                                                                                                        Deprecated since v2.0.0. This function may be removed in future versions. Similar functionality has been added to the frodo-cli code base.

                                                                                                                                                                                                                                                                                                                                                                                                                                        -
                                                                                                                                                                                                                                                                                                                                                                                                                                      • Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                        • clientId: string
                                                                                                                                                                                                                                                                                                                                                                                                                                        • clientSecret: string
                                                                                                                                                                                                                                                                                                                                                                                                                                        • scope: string
                                                                                                                                                                                                                                                                                                                                                                                                                                        • secret: string | boolean
                                                                                                                                                                                                                                                                                                                                                                                                                                        • lifetime: number

                                                                                                                                                                                                                                                                                                                                                                                                                                        Returns Promise<any>

                                                                                                                                                                                                                                                                                                                                                                                                                                        Deprecated since v2.0.0. This function may be removed in future versions. Similar functionality has been added to the frodo-cli code base.

                                                                                                                                                                                                                                                                                                                                                                                                                                        -
                                                                                                                                                                                                                                                                                                                                                                                                                                      • Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                        • clientId: string
                                                                                                                                                                                                                                                                                                                                                                                                                                        • clientSecret: string

                                                                                                                                                                                                                                                                                                                                                                                                                                        Returns Promise<void>

                                                                                                                                                                                                                                                                                                                                                                                                                                        Deprecated since v2.0.0. This function may be removed in future versions. Similar functionality has been added to the frodo-cli code base.

                                                                                                                                                                                                                                                                                                                                                                                                                                        -
                                                                                                                                                                                                                                                                                                                                                                                                                                      • Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                        • clientId: string

                                                                                                                                                                                                                                                                                                                                                                                                                                        Returns Promise<void>

                                                                                                                                                                                                                                                                                                                                                                                                                                        Deprecated since v2.0.0. This function may be removed in future versions. Similar functionality has been added to the frodo-cli code base.

                                                                                                                                                                                                                                                                                                                                                                                                                                        -
                                                                                                                                                                                                                                                                                                                                                                                                                                      • Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                        • includeCustomized: boolean
                                                                                                                                                                                                                                                                                                                                                                                                                                        • dryRun: boolean

                                                                                                                                                                                                                                                                                                                                                                                                                                        Returns Promise<void>

                                                                                                                                                                                                                                                                                                                                                                                                                                        Deprecated since v2.0.0. This function may be removed in future versions. Similar functionality has been added to the frodo-cli code base.

                                                                                                                                                                                                                                                                                                                                                                                                                                        -
                                                                                                                                                                                                                                                                                                                                                                                                                                      • Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                        • showProtected: boolean

                                                                                                                                                                                                                                                                                                                                                                                                                                        Returns Promise<string[]>

                                                                                                                                                                                                                                                                                                                                                                                                                                        Deprecated since v2.0.0. This function may be removed in future versions. Similar functionality has been added to the frodo-cli code base.

                                                                                                                                                                                                                                                                                                                                                                                                                                        -
                                                                                                                                                                                                                                                                                                                                                                                                                                      • Returns Promise<string[]>

                                                                                                                                                                                                                                                                                                                                                                                                                                        Deprecated since v2.0.0. This function may be removed in future versions. Similar functionality has been added to the frodo-cli code base.

                                                                                                                                                                                                                                                                                                                                                                                                                                        -
                                                                                                                                                                                                                                                                                                                                                                                                                                      • Returns Promise<string[]>

                                                                                                                                                                                                                                                                                                                                                                                                                                        Deprecated since v2.0.0. This function may be removed in future versions. Similar functionality has been added to the frodo-cli code base.

                                                                                                                                                                                                                                                                                                                                                                                                                                        -
                                                                                                                                                                                                                                                                                                                                                                                                                                      • Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                        • subject: string

                                                                                                                                                                                                                                                                                                                                                                                                                                        Returns Promise<void>

                                                                                                                                                                                                                                                                                                                                                                                                                                        Deprecated since v2.0.0. This function may be removed in future versions. Similar functionality has been added to the frodo-cli code base.

                                                                                                                                                                                                                                                                                                                                                                                                                                        -
                                                                                                                                                                                                                                                                                                                                                                                                                                      • Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                        • excludeCustomized: boolean
                                                                                                                                                                                                                                                                                                                                                                                                                                        • extendPermissions: boolean
                                                                                                                                                                                                                                                                                                                                                                                                                                        • dryRun: boolean

                                                                                                                                                                                                                                                                                                                                                                                                                                        Returns Promise<void>

                                                                                                                                                                                                                                                                                                                                                                                                                                        Deprecated since v2.0.0. This function may be removed in future versions. Similar functionality has been added to the frodo-cli code base.

                                                                                                                                                                                                                                                                                                                                                                                                                                        -
                                                                                                                                                                                                                                                                                                                                                                                                                                      • Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                        • clientId: string

                                                                                                                                                                                                                                                                                                                                                                                                                                        Returns Promise<void>

                                                                                                                                                                                                                                                                                                                                                                                                                                        Deprecated since v2.0.0. This function may be removed in future versions. Similar functionality has been added to the frodo-cli code base.

                                                                                                                                                                                                                                                                                                                                                                                                                                        -
                                                                                                                                                                                                                                                                                                                                                                                                                                      • Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                        • includeCustomized: boolean
                                                                                                                                                                                                                                                                                                                                                                                                                                        • dryRun: boolean

                                                                                                                                                                                                                                                                                                                                                                                                                                        Returns Promise<void>

                                                                                                                                                                                                                                                                                                                                                                                                                                        Deprecated since v2.0.0. This function may be removed in future versions. Similar functionality has been added to the frodo-cli code base.

                                                                                                                                                                                                                                                                                                                                                                                                                                        -
                                                                                                                                                                                                                                                                                                                                                                                                                                      +

                                                                                                                                                                                                                                                                                                                                                                                                                                      Methods

                                                                                                                                                                                                                                                                                                                                                                                                                                      • Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                        • clientId: string
                                                                                                                                                                                                                                                                                                                                                                                                                                        • Optionalaud: string
                                                                                                                                                                                                                                                                                                                                                                                                                                        • Optionaljwk: JwkRsa
                                                                                                                                                                                                                                                                                                                                                                                                                                        • Optionaloptions: { save: boolean }

                                                                                                                                                                                                                                                                                                                                                                                                                                        Returns Promise<
                                                                                                                                                                                                                                                                                                                                                                                                                                            {
                                                                                                                                                                                                                                                                                                                                                                                                                                                client: OAuth2ClientSkeleton;
                                                                                                                                                                                                                                                                                                                                                                                                                                                jwk: JwkRsa;
                                                                                                                                                                                                                                                                                                                                                                                                                                                jwks: JwksInterface;
                                                                                                                                                                                                                                                                                                                                                                                                                                                jwt: any;
                                                                                                                                                                                                                                                                                                                                                                                                                                            },
                                                                                                                                                                                                                                                                                                                                                                                                                                        >

                                                                                                                                                                                                                                                                                                                                                                                                                                      • Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                        • apiKey: string
                                                                                                                                                                                                                                                                                                                                                                                                                                        • apiSecret: string
                                                                                                                                                                                                                                                                                                                                                                                                                                        • OptionalcustomUsernames: string[]
                                                                                                                                                                                                                                                                                                                                                                                                                                        • OptionalcustomUserAgents: string[]
                                                                                                                                                                                                                                                                                                                                                                                                                                        • OptionalcustomIPs: string[]
                                                                                                                                                                                                                                                                                                                                                                                                                                        • OptionalloginsPerUser: number
                                                                                                                                                                                                                                                                                                                                                                                                                                        • Optionalservice: string

                                                                                                                                                                                                                                                                                                                                                                                                                                        Returns Promise<void>

                                                                                                                                                                                                                                                                                                                                                                                                                                      Deprecated

                                                                                                                                                                                                                                                                                                                                                                                                                                      • Returns Promise<void>

                                                                                                                                                                                                                                                                                                                                                                                                                                        Deprecated since v2.0.0. This function may be removed in future versions. Similar functionality has been added to the frodo-cli code base.

                                                                                                                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                                                                                                                      • Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                        • clientId: string
                                                                                                                                                                                                                                                                                                                                                                                                                                        • clientSecret: string
                                                                                                                                                                                                                                                                                                                                                                                                                                        • scope: string
                                                                                                                                                                                                                                                                                                                                                                                                                                        • secret: string | boolean
                                                                                                                                                                                                                                                                                                                                                                                                                                        • lifetime: number

                                                                                                                                                                                                                                                                                                                                                                                                                                        Returns Promise<any>

                                                                                                                                                                                                                                                                                                                                                                                                                                        Deprecated since v2.0.0. This function may be removed in future versions. Similar functionality has been added to the frodo-cli code base.

                                                                                                                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                                                                                                                      • Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                        • clientId: string
                                                                                                                                                                                                                                                                                                                                                                                                                                        • clientSecret: string

                                                                                                                                                                                                                                                                                                                                                                                                                                        Returns Promise<void>

                                                                                                                                                                                                                                                                                                                                                                                                                                        Deprecated since v2.0.0. This function may be removed in future versions. Similar functionality has been added to the frodo-cli code base.

                                                                                                                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                                                                                                                      • Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                        • clientId: string

                                                                                                                                                                                                                                                                                                                                                                                                                                        Returns Promise<void>

                                                                                                                                                                                                                                                                                                                                                                                                                                        Deprecated since v2.0.0. This function may be removed in future versions. Similar functionality has been added to the frodo-cli code base.

                                                                                                                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                                                                                                                      • Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                        • includeCustomized: boolean
                                                                                                                                                                                                                                                                                                                                                                                                                                        • dryRun: boolean

                                                                                                                                                                                                                                                                                                                                                                                                                                        Returns Promise<void>

                                                                                                                                                                                                                                                                                                                                                                                                                                        Deprecated since v2.0.0. This function may be removed in future versions. Similar functionality has been added to the frodo-cli code base.

                                                                                                                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                                                                                                                      • Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                        • showProtected: boolean

                                                                                                                                                                                                                                                                                                                                                                                                                                        Returns Promise<string[]>

                                                                                                                                                                                                                                                                                                                                                                                                                                        Deprecated since v2.0.0. This function may be removed in future versions. Similar functionality has been added to the frodo-cli code base.

                                                                                                                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                                                                                                                      • Returns Promise<string[]>

                                                                                                                                                                                                                                                                                                                                                                                                                                        Deprecated since v2.0.0. This function may be removed in future versions. Similar functionality has been added to the frodo-cli code base.

                                                                                                                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                                                                                                                      • Returns Promise<string[]>

                                                                                                                                                                                                                                                                                                                                                                                                                                        Deprecated since v2.0.0. This function may be removed in future versions. Similar functionality has been added to the frodo-cli code base.

                                                                                                                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                                                                                                                      • Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                        • subject: string

                                                                                                                                                                                                                                                                                                                                                                                                                                        Returns Promise<void>

                                                                                                                                                                                                                                                                                                                                                                                                                                        Deprecated since v2.0.0. This function may be removed in future versions. Similar functionality has been added to the frodo-cli code base.

                                                                                                                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                                                                                                                      • Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                        • excludeCustomized: boolean
                                                                                                                                                                                                                                                                                                                                                                                                                                        • extendPermissions: boolean
                                                                                                                                                                                                                                                                                                                                                                                                                                        • dryRun: boolean

                                                                                                                                                                                                                                                                                                                                                                                                                                        Returns Promise<void>

                                                                                                                                                                                                                                                                                                                                                                                                                                        Deprecated since v2.0.0. This function may be removed in future versions. Similar functionality has been added to the frodo-cli code base.

                                                                                                                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                                                                                                                      • Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                        • clientId: string

                                                                                                                                                                                                                                                                                                                                                                                                                                        Returns Promise<void>

                                                                                                                                                                                                                                                                                                                                                                                                                                        Deprecated since v2.0.0. This function may be removed in future versions. Similar functionality has been added to the frodo-cli code base.

                                                                                                                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                                                                                                                      • Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                        • includeCustomized: boolean
                                                                                                                                                                                                                                                                                                                                                                                                                                        • dryRun: boolean

                                                                                                                                                                                                                                                                                                                                                                                                                                        Returns Promise<void>

                                                                                                                                                                                                                                                                                                                                                                                                                                        Deprecated since v2.0.0. This function may be removed in future versions. Similar functionality has been added to the frodo-cli code base.

                                                                                                                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                                                                                                                      diff --git a/docs/types/Reference.AdminFederation.html b/docs/types/Reference.AdminFederation.html index 32395e41c..eaafa10ee 100644 --- a/docs/types/Reference.AdminFederation.html +++ b/docs/types/Reference.AdminFederation.html @@ -1,4 +1,4 @@ -AdminFederation | Frodo Library - v4.0.0-10
                                                                                                                                                                                                                                                                                                                                                                                                                                      Frodo Library - v4.0.0-10
                                                                                                                                                                                                                                                                                                                                                                                                                                        Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                                        Type Alias AdminFederation

                                                                                                                                                                                                                                                                                                                                                                                                                                        type AdminFederation = {
                                                                                                                                                                                                                                                                                                                                                                                                                                            createAdminFederationExportTemplate(): AdminFederationExportInterface;
                                                                                                                                                                                                                                                                                                                                                                                                                                            createAdminFederationProvider(
                                                                                                                                                                                                                                                                                                                                                                                                                                                providerType: string,
                                                                                                                                                                                                                                                                                                                                                                                                                                                providerData: SocialIdpSkeleton,
                                                                                                                                                                                                                                                                                                                                                                                                                                                providerId?: string,
                                                                                                                                                                                                                                                                                                                                                                                                                                            ): Promise<SocialIdpSkeleton>;
                                                                                                                                                                                                                                                                                                                                                                                                                                            deleteAdminFederationProvider(
                                                                                                                                                                                                                                                                                                                                                                                                                                                providerId: string,
                                                                                                                                                                                                                                                                                                                                                                                                                                            ): Promise<SocialIdpSkeleton>;
                                                                                                                                                                                                                                                                                                                                                                                                                                            exportAdminFederationProvider(
                                                                                                                                                                                                                                                                                                                                                                                                                                                providerId: string,
                                                                                                                                                                                                                                                                                                                                                                                                                                            ): Promise<AdminFederationExportInterface>;
                                                                                                                                                                                                                                                                                                                                                                                                                                            exportAdminFederationProviders(): Promise<AdminFederationExportInterface>;
                                                                                                                                                                                                                                                                                                                                                                                                                                            getAdminFederationProvider(providerId: string): Promise<SocialIdpSkeleton>;
                                                                                                                                                                                                                                                                                                                                                                                                                                            getAdminFederationProviders(): Promise<SocialIdpSkeleton[]>;
                                                                                                                                                                                                                                                                                                                                                                                                                                            importAdminFederationProvider(
                                                                                                                                                                                                                                                                                                                                                                                                                                                providerId: string,
                                                                                                                                                                                                                                                                                                                                                                                                                                                importData: AdminFederationExportInterface,
                                                                                                                                                                                                                                                                                                                                                                                                                                            ): Promise<SocialIdpSkeleton>;
                                                                                                                                                                                                                                                                                                                                                                                                                                            importAdminFederationProviders(
                                                                                                                                                                                                                                                                                                                                                                                                                                                importData: AdminFederationExportInterface,
                                                                                                                                                                                                                                                                                                                                                                                                                                            ): Promise<SocialIdpSkeleton[]>;
                                                                                                                                                                                                                                                                                                                                                                                                                                            importFirstAdminFederationProvider(
                                                                                                                                                                                                                                                                                                                                                                                                                                                importData: AdminFederationExportInterface,
                                                                                                                                                                                                                                                                                                                                                                                                                                            ): Promise<SocialIdpSkeleton>;
                                                                                                                                                                                                                                                                                                                                                                                                                                            putProviderByTypeAndId(
                                                                                                                                                                                                                                                                                                                                                                                                                                                providerType: string,
                                                                                                                                                                                                                                                                                                                                                                                                                                                providerId: string,
                                                                                                                                                                                                                                                                                                                                                                                                                                                providerData: SocialIdpSkeleton,
                                                                                                                                                                                                                                                                                                                                                                                                                                            ): Promise<SocialIdpSkeleton>;
                                                                                                                                                                                                                                                                                                                                                                                                                                            readAdminFederationProvider(providerId: string): Promise<SocialIdpSkeleton>;
                                                                                                                                                                                                                                                                                                                                                                                                                                            readAdminFederationProviders(): Promise<SocialIdpSkeleton[]>;
                                                                                                                                                                                                                                                                                                                                                                                                                                            updateAdminFederationProvider(
                                                                                                                                                                                                                                                                                                                                                                                                                                                providerType: string,
                                                                                                                                                                                                                                                                                                                                                                                                                                                providerId: string,
                                                                                                                                                                                                                                                                                                                                                                                                                                                providerData: SocialIdpSkeleton,
                                                                                                                                                                                                                                                                                                                                                                                                                                            ): Promise<SocialIdpSkeleton>;
                                                                                                                                                                                                                                                                                                                                                                                                                                        }
                                                                                                                                                                                                                                                                                                                                                                                                                                        Index

                                                                                                                                                                                                                                                                                                                                                                                                                                        Methods

                                                                                                                                                                                                                                                                                                                                                                                                                                        createAdminFederationExportTemplate +AdminFederation | Frodo Library - v4.0.0-11
                                                                                                                                                                                                                                                                                                                                                                                                                                        Frodo Library - v4.0.0-11
                                                                                                                                                                                                                                                                                                                                                                                                                                          Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                                          Type Alias AdminFederation

                                                                                                                                                                                                                                                                                                                                                                                                                                          type AdminFederation = {
                                                                                                                                                                                                                                                                                                                                                                                                                                              createAdminFederationExportTemplate(): AdminFederationExportInterface;
                                                                                                                                                                                                                                                                                                                                                                                                                                              createAdminFederationProvider(
                                                                                                                                                                                                                                                                                                                                                                                                                                                  providerType: string,
                                                                                                                                                                                                                                                                                                                                                                                                                                                  providerData: SocialIdpSkeleton,
                                                                                                                                                                                                                                                                                                                                                                                                                                                  providerId?: string,
                                                                                                                                                                                                                                                                                                                                                                                                                                              ): Promise<SocialIdpSkeleton>;
                                                                                                                                                                                                                                                                                                                                                                                                                                              deleteAdminFederationProvider(
                                                                                                                                                                                                                                                                                                                                                                                                                                                  providerId: string,
                                                                                                                                                                                                                                                                                                                                                                                                                                              ): Promise<SocialIdpSkeleton>;
                                                                                                                                                                                                                                                                                                                                                                                                                                              exportAdminFederationProvider(
                                                                                                                                                                                                                                                                                                                                                                                                                                                  providerId: string,
                                                                                                                                                                                                                                                                                                                                                                                                                                              ): Promise<AdminFederationExportInterface>;
                                                                                                                                                                                                                                                                                                                                                                                                                                              exportAdminFederationProviders(): Promise<AdminFederationExportInterface>;
                                                                                                                                                                                                                                                                                                                                                                                                                                              getAdminFederationProvider(providerId: string): Promise<SocialIdpSkeleton>;
                                                                                                                                                                                                                                                                                                                                                                                                                                              getAdminFederationProviders(): Promise<SocialIdpSkeleton[]>;
                                                                                                                                                                                                                                                                                                                                                                                                                                              importAdminFederationProvider(
                                                                                                                                                                                                                                                                                                                                                                                                                                                  providerId: string,
                                                                                                                                                                                                                                                                                                                                                                                                                                                  importData: AdminFederationExportInterface,
                                                                                                                                                                                                                                                                                                                                                                                                                                              ): Promise<SocialIdpSkeleton>;
                                                                                                                                                                                                                                                                                                                                                                                                                                              importAdminFederationProviders(
                                                                                                                                                                                                                                                                                                                                                                                                                                                  importData: AdminFederationExportInterface,
                                                                                                                                                                                                                                                                                                                                                                                                                                              ): Promise<SocialIdpSkeleton[]>;
                                                                                                                                                                                                                                                                                                                                                                                                                                              importFirstAdminFederationProvider(
                                                                                                                                                                                                                                                                                                                                                                                                                                                  importData: AdminFederationExportInterface,
                                                                                                                                                                                                                                                                                                                                                                                                                                              ): Promise<SocialIdpSkeleton>;
                                                                                                                                                                                                                                                                                                                                                                                                                                              putProviderByTypeAndId(
                                                                                                                                                                                                                                                                                                                                                                                                                                                  providerType: string,
                                                                                                                                                                                                                                                                                                                                                                                                                                                  providerId: string,
                                                                                                                                                                                                                                                                                                                                                                                                                                                  providerData: SocialIdpSkeleton,
                                                                                                                                                                                                                                                                                                                                                                                                                                              ): Promise<SocialIdpSkeleton>;
                                                                                                                                                                                                                                                                                                                                                                                                                                              readAdminFederationProvider(providerId: string): Promise<SocialIdpSkeleton>;
                                                                                                                                                                                                                                                                                                                                                                                                                                              readAdminFederationProviders(): Promise<SocialIdpSkeleton[]>;
                                                                                                                                                                                                                                                                                                                                                                                                                                              updateAdminFederationProvider(
                                                                                                                                                                                                                                                                                                                                                                                                                                                  providerType: string,
                                                                                                                                                                                                                                                                                                                                                                                                                                                  providerId: string,
                                                                                                                                                                                                                                                                                                                                                                                                                                                  providerData: SocialIdpSkeleton,
                                                                                                                                                                                                                                                                                                                                                                                                                                              ): Promise<SocialIdpSkeleton>;
                                                                                                                                                                                                                                                                                                                                                                                                                                          }
                                                                                                                                                                                                                                                                                                                                                                                                                                          Index

                                                                                                                                                                                                                                                                                                                                                                                                                                          Methods

                                                                                                                                                                                                                                                                                                                                                                                                                                          Returns Promise<SocialIdpSkeleton>

                                                                                                                                                                                                                                                                                                                                                                                                                                          Returns Promise<SocialIdpSkeleton[]>

                                                                                                                                                                                                                                                                                                                                                                                                                                          • Read admin federation provider

                                                                                                                                                                                                                                                                                                                                                                                                                                            +

                                                                                                                                                                                                                                                                                                                                                                                                                                          Returns Promise<SocialIdpSkeleton>

                                                                                                                                                                                                                                                                                                                                                                                                                                          Deprecated

                                                                                                                                                                                                                                                                                                                                                                                                                                          Deprecated

                                                                                                                                                                                                                                                                                                                                                                                                                                          • Update or create admin federation provider

                                                                                                                                                                                                                                                                                                                                                                                                                                            Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                            • providerType: string

                                                                                                                                                                                                                                                                                                                                                                                                                                              social identity provider type

                                                                                                                                                                                                                                                                                                                                                                                                                                            • providerId: string

                                                                                                                                                                                                                                                                                                                                                                                                                                              social identity provider id/name

                                                                                                                                                                                                                                                                                                                                                                                                                                            • providerData: SocialIdpSkeleton

                                                                                                                                                                                                                                                                                                                                                                                                                                              social identity provider data

                                                                                                                                                                                                                                                                                                                                                                                                                                              @@ -66,4 +66,4 @@
                                                                                                                                                                                                                                                                                                                                                                                                                                              updateAdminFederationProvider(providerType: string, providerId: string, providerData: SocialIdpSkeleton): Promise<SocialIdpSkeleton>
                                                                                                                                                                                                                                                                                                                                                                                                                                               
                                                                                                                                                                                                                                                                                                                                                                                                                                              -
                                                                                                                                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                                                                                                                                          diff --git a/docs/types/Reference.AdminFederationConfigSkeleton.html b/docs/types/Reference.AdminFederationConfigSkeleton.html index bf31f49dc..e229be6ea 100644 --- a/docs/types/Reference.AdminFederationConfigSkeleton.html +++ b/docs/types/Reference.AdminFederationConfigSkeleton.html @@ -1 +1 @@ -AdminFederationConfigSkeleton | Frodo Library - v4.0.0-10
                                                                                                                                                                                                                                                                                                                                                                                                                                          Frodo Library - v4.0.0-10
                                                                                                                                                                                                                                                                                                                                                                                                                                            Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                                            Type Alias AdminFederationConfigSkeleton

                                                                                                                                                                                                                                                                                                                                                                                                                                            AdminFederationConfigSkeleton: IdObjectSkeletonInterface & {
                                                                                                                                                                                                                                                                                                                                                                                                                                                groups: {
                                                                                                                                                                                                                                                                                                                                                                                                                                                    claim: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                    mappings: { "super-admins": string[]; "tenant-admins": string[] };
                                                                                                                                                                                                                                                                                                                                                                                                                                                };
                                                                                                                                                                                                                                                                                                                                                                                                                                            }
                                                                                                                                                                                                                                                                                                                                                                                                                                            +AdminFederationConfigSkeleton | Frodo Library - v4.0.0-11
                                                                                                                                                                                                                                                                                                                                                                                                                                            Frodo Library - v4.0.0-11
                                                                                                                                                                                                                                                                                                                                                                                                                                              Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                                              Type Alias AdminFederationConfigSkeleton

                                                                                                                                                                                                                                                                                                                                                                                                                                              AdminFederationConfigSkeleton: IdObjectSkeletonInterface & {
                                                                                                                                                                                                                                                                                                                                                                                                                                                  groups: {
                                                                                                                                                                                                                                                                                                                                                                                                                                                      claim: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                      mappings: { "super-admins": string[]; "tenant-admins": string[] };
                                                                                                                                                                                                                                                                                                                                                                                                                                                  };
                                                                                                                                                                                                                                                                                                                                                                                                                                              }
                                                                                                                                                                                                                                                                                                                                                                                                                                              diff --git a/docs/types/Reference.Agent.html b/docs/types/Reference.Agent.html index 0c3231797..9d6f88da8 100644 --- a/docs/types/Reference.Agent.html +++ b/docs/types/Reference.Agent.html @@ -1,4 +1,4 @@ -Agent | Frodo Library - v4.0.0-10
                                                                                                                                                                                                                                                                                                                                                                                                                                              Frodo Library - v4.0.0-10
                                                                                                                                                                                                                                                                                                                                                                                                                                                Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                                                Type Alias Agent

                                                                                                                                                                                                                                                                                                                                                                                                                                                type Agent = {
                                                                                                                                                                                                                                                                                                                                                                                                                                                    createAgentExportTemplate(): AgentExportInterface;
                                                                                                                                                                                                                                                                                                                                                                                                                                                    createAgentGroupExportTemplate(): AgentGroupExportInterface;
                                                                                                                                                                                                                                                                                                                                                                                                                                                    createIdentityGatewayAgent(
                                                                                                                                                                                                                                                                                                                                                                                                                                                        gatewayId: string,
                                                                                                                                                                                                                                                                                                                                                                                                                                                        gatewayData: AmConfigEntityInterface,
                                                                                                                                                                                                                                                                                                                                                                                                                                                    ): Promise<AmConfigEntityInterface>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                    createJavaAgent(
                                                                                                                                                                                                                                                                                                                                                                                                                                                        agentId: string,
                                                                                                                                                                                                                                                                                                                                                                                                                                                        agentData: AmConfigEntityInterface,
                                                                                                                                                                                                                                                                                                                                                                                                                                                    ): Promise<AmConfigEntityInterface>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                    createWebAgent(
                                                                                                                                                                                                                                                                                                                                                                                                                                                        agentId: string,
                                                                                                                                                                                                                                                                                                                                                                                                                                                        agentData: AmConfigEntityInterface,
                                                                                                                                                                                                                                                                                                                                                                                                                                                    ): Promise<AmConfigEntityInterface>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                    deleteAgent(agentId: string): Promise<void>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                    deleteAgents(): Promise<void>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                    deleteIdentityGatewayAgent(agentId: string): Promise<void>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                    deleteIdentityGatewayAgents(): Promise<void>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                    deleteJavaAgent(agentId: string): Promise<void>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                    deleteJavaAgents(): Promise<void>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                    deleteWebAgent(agentId: string): Promise<void>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                    deleteWebAgents(): Promise<void>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                    exportAgent(
                                                                                                                                                                                                                                                                                                                                                                                                                                                        agentId: string,
                                                                                                                                                                                                                                                                                                                                                                                                                                                        globalConfig: boolean,
                                                                                                                                                                                                                                                                                                                                                                                                                                                    ): Promise<AgentExportInterface>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                    exportAgentGroup(groupId: string): Promise<AgentGroupExportInterface>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                    exportAgentGroups(): Promise<AgentGroupExportInterface>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                    exportAgents(globalConfig: boolean): Promise<AgentExportInterface>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                    exportIdentityGatewayAgent(agentId: string): Promise<AgentExportInterface>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                    exportIdentityGatewayAgents(): Promise<AgentExportInterface>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                    exportJavaAgent(agentId: string): Promise<AgentExportInterface>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                    exportJavaAgents(): Promise<AgentExportInterface>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                    exportWebAgent(agentId: string): Promise<AgentExportInterface>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                    exportWebAgents(): Promise<AgentExportInterface>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                    getAgent(agentId: string): Promise<AmConfigEntityInterface>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                    getAgentByTypeAndId(
                                                                                                                                                                                                                                                                                                                                                                                                                                                        agentType: AgentType,
                                                                                                                                                                                                                                                                                                                                                                                                                                                        agentId: string,
                                                                                                                                                                                                                                                                                                                                                                                                                                                    ): Promise<AmConfigEntityInterface>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                    getAgents(): Promise<AmConfigEntityInterface[]>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                    getIdentityGatewayAgent(
                                                                                                                                                                                                                                                                                                                                                                                                                                                        gatewayId: string,
                                                                                                                                                                                                                                                                                                                                                                                                                                                    ): Promise<AmConfigEntityInterface>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                    getIdentityGatewayAgents(): Promise<AmConfigEntityInterface[]>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                    getJavaAgent(agentId: string): Promise<AmConfigEntityInterface>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                    getJavaAgents(): Promise<AmConfigEntityInterface[]>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                    getWebAgent(agentId: string): Promise<AmConfigEntityInterface>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                    getWebAgents(): Promise<AmConfigEntityInterface[]>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                    importAgent(
                                                                                                                                                                                                                                                                                                                                                                                                                                                        agentId: string,
                                                                                                                                                                                                                                                                                                                                                                                                                                                        importData: AgentExportInterface,
                                                                                                                                                                                                                                                                                                                                                                                                                                                        globalConfig: boolean,
                                                                                                                                                                                                                                                                                                                                                                                                                                                    ): Promise<AmConfigEntityInterface>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                    importAgentGroup(
                                                                                                                                                                                                                                                                                                                                                                                                                                                        agentGroupId: string,
                                                                                                                                                                                                                                                                                                                                                                                                                                                        importData: AgentGroupExportInterface,
                                                                                                                                                                                                                                                                                                                                                                                                                                                    ): Promise<AmConfigEntityInterface>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                    importAgentGroups(
                                                                                                                                                                                                                                                                                                                                                                                                                                                        importData: AgentGroupExportInterface,
                                                                                                                                                                                                                                                                                                                                                                                                                                                    ): Promise<AmConfigEntityInterface[]>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                    importAgents(
                                                                                                                                                                                                                                                                                                                                                                                                                                                        importData: AgentExportInterface,
                                                                                                                                                                                                                                                                                                                                                                                                                                                        globalConfig: boolean,
                                                                                                                                                                                                                                                                                                                                                                                                                                                    ): Promise<AmConfigEntityInterface[]>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                    importIdentityGatewayAgent(
                                                                                                                                                                                                                                                                                                                                                                                                                                                        agentId: string,
                                                                                                                                                                                                                                                                                                                                                                                                                                                        importData: AgentExportInterface,
                                                                                                                                                                                                                                                                                                                                                                                                                                                    ): Promise<AmConfigEntityInterface>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                    importIdentityGatewayAgents(
                                                                                                                                                                                                                                                                                                                                                                                                                                                        importData: AgentExportInterface,
                                                                                                                                                                                                                                                                                                                                                                                                                                                    ): Promise<void>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                    importJavaAgent(
                                                                                                                                                                                                                                                                                                                                                                                                                                                        agentId: string,
                                                                                                                                                                                                                                                                                                                                                                                                                                                        importData: AgentExportInterface,
                                                                                                                                                                                                                                                                                                                                                                                                                                                    ): Promise<AmConfigEntityInterface>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                    importJavaAgents(importData: AgentExportInterface): Promise<void>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                    importWebAgent(
                                                                                                                                                                                                                                                                                                                                                                                                                                                        agentId: string,
                                                                                                                                                                                                                                                                                                                                                                                                                                                        importData: AgentExportInterface,
                                                                                                                                                                                                                                                                                                                                                                                                                                                    ): Promise<AmConfigEntityInterface>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                    importWebAgents(importData: AgentExportInterface): Promise<void>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                    putIdentityGatewayAgent(
                                                                                                                                                                                                                                                                                                                                                                                                                                                        gatewayId: string,
                                                                                                                                                                                                                                                                                                                                                                                                                                                        gatewayData: AmConfigEntityInterface,
                                                                                                                                                                                                                                                                                                                                                                                                                                                    ): Promise<AmConfigEntityInterface>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                    putJavaAgent(
                                                                                                                                                                                                                                                                                                                                                                                                                                                        agentId: string,
                                                                                                                                                                                                                                                                                                                                                                                                                                                        agentData: AmConfigEntityInterface,
                                                                                                                                                                                                                                                                                                                                                                                                                                                    ): Promise<AmConfigEntityInterface>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                    putWebAgent(
                                                                                                                                                                                                                                                                                                                                                                                                                                                        agentId: string,
                                                                                                                                                                                                                                                                                                                                                                                                                                                        agentData: AmConfigEntityInterface,
                                                                                                                                                                                                                                                                                                                                                                                                                                                    ): Promise<AmConfigEntityInterface>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                    readAgent(
                                                                                                                                                                                                                                                                                                                                                                                                                                                        agentId: string,
                                                                                                                                                                                                                                                                                                                                                                                                                                                        globalConfig: boolean,
                                                                                                                                                                                                                                                                                                                                                                                                                                                    ): Promise<AmConfigEntityInterface>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                    readAgentByTypeAndId(
                                                                                                                                                                                                                                                                                                                                                                                                                                                        agentType: AgentType,
                                                                                                                                                                                                                                                                                                                                                                                                                                                        agentId: string,
                                                                                                                                                                                                                                                                                                                                                                                                                                                    ): Promise<AmConfigEntityInterface>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                    readAgentGroup(groupId: string): Promise<AmConfigEntityInterface>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                    readAgentGroups(): Promise<AmConfigEntityInterface[]>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                    readAgents(globalConfig: boolean): Promise<AmConfigEntityInterface[]>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                    readIdentityGatewayAgent(
                                                                                                                                                                                                                                                                                                                                                                                                                                                        gatewayId: string,
                                                                                                                                                                                                                                                                                                                                                                                                                                                    ): Promise<AmConfigEntityInterface>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                    readIdentityGatewayAgents(): Promise<AmConfigEntityInterface[]>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                    readJavaAgent(agentId: string): Promise<AmConfigEntityInterface>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                    readJavaAgents(): Promise<AmConfigEntityInterface[]>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                    readWebAgent(agentId: string): Promise<AmConfigEntityInterface>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                    readWebAgents(): Promise<AmConfigEntityInterface[]>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                    updateIdentityGatewayAgent(
                                                                                                                                                                                                                                                                                                                                                                                                                                                        gatewayId: string,
                                                                                                                                                                                                                                                                                                                                                                                                                                                        gatewayData: AmConfigEntityInterface,
                                                                                                                                                                                                                                                                                                                                                                                                                                                    ): Promise<AmConfigEntityInterface>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                    updateJavaAgent(
                                                                                                                                                                                                                                                                                                                                                                                                                                                        agentId: string,
                                                                                                                                                                                                                                                                                                                                                                                                                                                        agentData: AmConfigEntityInterface,
                                                                                                                                                                                                                                                                                                                                                                                                                                                    ): Promise<AmConfigEntityInterface>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                    updateWebAgent(
                                                                                                                                                                                                                                                                                                                                                                                                                                                        agentId: string,
                                                                                                                                                                                                                                                                                                                                                                                                                                                        agentData: AmConfigEntityInterface,
                                                                                                                                                                                                                                                                                                                                                                                                                                                    ): Promise<AmConfigEntityInterface>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                }
                                                                                                                                                                                                                                                                                                                                                                                                                                                Index

                                                                                                                                                                                                                                                                                                                                                                                                                                                Methods

                                                                                                                                                                                                                                                                                                                                                                                                                                                createAgentExportTemplate +Agent | Frodo Library - v4.0.0-11
                                                                                                                                                                                                                                                                                                                                                                                                                                                Frodo Library - v4.0.0-11
                                                                                                                                                                                                                                                                                                                                                                                                                                                  Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                                                  Type Alias Agent

                                                                                                                                                                                                                                                                                                                                                                                                                                                  type Agent = {
                                                                                                                                                                                                                                                                                                                                                                                                                                                      createAgentExportTemplate(): AgentExportInterface;
                                                                                                                                                                                                                                                                                                                                                                                                                                                      createAgentGroupExportTemplate(): AgentGroupExportInterface;
                                                                                                                                                                                                                                                                                                                                                                                                                                                      createIdentityGatewayAgent(
                                                                                                                                                                                                                                                                                                                                                                                                                                                          gatewayId: string,
                                                                                                                                                                                                                                                                                                                                                                                                                                                          gatewayData: AmConfigEntityInterface,
                                                                                                                                                                                                                                                                                                                                                                                                                                                      ): Promise<AmConfigEntityInterface>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                      createJavaAgent(
                                                                                                                                                                                                                                                                                                                                                                                                                                                          agentId: string,
                                                                                                                                                                                                                                                                                                                                                                                                                                                          agentData: AmConfigEntityInterface,
                                                                                                                                                                                                                                                                                                                                                                                                                                                      ): Promise<AmConfigEntityInterface>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                      createWebAgent(
                                                                                                                                                                                                                                                                                                                                                                                                                                                          agentId: string,
                                                                                                                                                                                                                                                                                                                                                                                                                                                          agentData: AmConfigEntityInterface,
                                                                                                                                                                                                                                                                                                                                                                                                                                                      ): Promise<AmConfigEntityInterface>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                      deleteAgent(agentId: string): Promise<void>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                      deleteAgents(): Promise<void>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                      deleteIdentityGatewayAgent(agentId: string): Promise<void>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                      deleteIdentityGatewayAgents(): Promise<void>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                      deleteJavaAgent(agentId: string): Promise<void>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                      deleteJavaAgents(): Promise<void>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                      deleteWebAgent(agentId: string): Promise<void>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                      deleteWebAgents(): Promise<void>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                      exportAgent(
                                                                                                                                                                                                                                                                                                                                                                                                                                                          agentId: string,
                                                                                                                                                                                                                                                                                                                                                                                                                                                          globalConfig: boolean,
                                                                                                                                                                                                                                                                                                                                                                                                                                                      ): Promise<AgentExportInterface>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                      exportAgentGroup(groupId: string): Promise<AgentGroupExportInterface>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                      exportAgentGroups(): Promise<AgentGroupExportInterface>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                      exportAgents(globalConfig: boolean): Promise<AgentExportInterface>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                      exportIdentityGatewayAgent(agentId: string): Promise<AgentExportInterface>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                      exportIdentityGatewayAgents(): Promise<AgentExportInterface>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                      exportJavaAgent(agentId: string): Promise<AgentExportInterface>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                      exportJavaAgents(): Promise<AgentExportInterface>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                      exportWebAgent(agentId: string): Promise<AgentExportInterface>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                      exportWebAgents(): Promise<AgentExportInterface>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                      getAgent(agentId: string): Promise<AmConfigEntityInterface>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                      getAgentByTypeAndId(
                                                                                                                                                                                                                                                                                                                                                                                                                                                          agentType: AgentType,
                                                                                                                                                                                                                                                                                                                                                                                                                                                          agentId: string,
                                                                                                                                                                                                                                                                                                                                                                                                                                                      ): Promise<AmConfigEntityInterface>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                      getAgents(): Promise<AmConfigEntityInterface[]>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                      getIdentityGatewayAgent(
                                                                                                                                                                                                                                                                                                                                                                                                                                                          gatewayId: string,
                                                                                                                                                                                                                                                                                                                                                                                                                                                      ): Promise<AmConfigEntityInterface>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                      getIdentityGatewayAgents(): Promise<AmConfigEntityInterface[]>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                      getJavaAgent(agentId: string): Promise<AmConfigEntityInterface>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                      getJavaAgents(): Promise<AmConfigEntityInterface[]>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                      getWebAgent(agentId: string): Promise<AmConfigEntityInterface>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                      getWebAgents(): Promise<AmConfigEntityInterface[]>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                      importAgent(
                                                                                                                                                                                                                                                                                                                                                                                                                                                          agentId: string,
                                                                                                                                                                                                                                                                                                                                                                                                                                                          importData: AgentExportInterface,
                                                                                                                                                                                                                                                                                                                                                                                                                                                          globalConfig: boolean,
                                                                                                                                                                                                                                                                                                                                                                                                                                                      ): Promise<AmConfigEntityInterface>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                      importAgentGroup(
                                                                                                                                                                                                                                                                                                                                                                                                                                                          agentGroupId: string,
                                                                                                                                                                                                                                                                                                                                                                                                                                                          importData: AgentGroupExportInterface,
                                                                                                                                                                                                                                                                                                                                                                                                                                                      ): Promise<AmConfigEntityInterface>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                      importAgentGroups(
                                                                                                                                                                                                                                                                                                                                                                                                                                                          importData: AgentGroupExportInterface,
                                                                                                                                                                                                                                                                                                                                                                                                                                                      ): Promise<AmConfigEntityInterface[]>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                      importAgents(
                                                                                                                                                                                                                                                                                                                                                                                                                                                          importData: AgentExportInterface,
                                                                                                                                                                                                                                                                                                                                                                                                                                                          globalConfig: boolean,
                                                                                                                                                                                                                                                                                                                                                                                                                                                      ): Promise<AmConfigEntityInterface[]>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                      importIdentityGatewayAgent(
                                                                                                                                                                                                                                                                                                                                                                                                                                                          agentId: string,
                                                                                                                                                                                                                                                                                                                                                                                                                                                          importData: AgentExportInterface,
                                                                                                                                                                                                                                                                                                                                                                                                                                                      ): Promise<AmConfigEntityInterface>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                      importIdentityGatewayAgents(
                                                                                                                                                                                                                                                                                                                                                                                                                                                          importData: AgentExportInterface,
                                                                                                                                                                                                                                                                                                                                                                                                                                                      ): Promise<void>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                      importJavaAgent(
                                                                                                                                                                                                                                                                                                                                                                                                                                                          agentId: string,
                                                                                                                                                                                                                                                                                                                                                                                                                                                          importData: AgentExportInterface,
                                                                                                                                                                                                                                                                                                                                                                                                                                                      ): Promise<AmConfigEntityInterface>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                      importJavaAgents(importData: AgentExportInterface): Promise<void>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                      importWebAgent(
                                                                                                                                                                                                                                                                                                                                                                                                                                                          agentId: string,
                                                                                                                                                                                                                                                                                                                                                                                                                                                          importData: AgentExportInterface,
                                                                                                                                                                                                                                                                                                                                                                                                                                                      ): Promise<AmConfigEntityInterface>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                      importWebAgents(importData: AgentExportInterface): Promise<void>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                      putIdentityGatewayAgent(
                                                                                                                                                                                                                                                                                                                                                                                                                                                          gatewayId: string,
                                                                                                                                                                                                                                                                                                                                                                                                                                                          gatewayData: AmConfigEntityInterface,
                                                                                                                                                                                                                                                                                                                                                                                                                                                      ): Promise<AmConfigEntityInterface>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                      putJavaAgent(
                                                                                                                                                                                                                                                                                                                                                                                                                                                          agentId: string,
                                                                                                                                                                                                                                                                                                                                                                                                                                                          agentData: AmConfigEntityInterface,
                                                                                                                                                                                                                                                                                                                                                                                                                                                      ): Promise<AmConfigEntityInterface>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                      putWebAgent(
                                                                                                                                                                                                                                                                                                                                                                                                                                                          agentId: string,
                                                                                                                                                                                                                                                                                                                                                                                                                                                          agentData: AmConfigEntityInterface,
                                                                                                                                                                                                                                                                                                                                                                                                                                                      ): Promise<AmConfigEntityInterface>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                      readAgent(
                                                                                                                                                                                                                                                                                                                                                                                                                                                          agentId: string,
                                                                                                                                                                                                                                                                                                                                                                                                                                                          globalConfig: boolean,
                                                                                                                                                                                                                                                                                                                                                                                                                                                      ): Promise<AmConfigEntityInterface>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                      readAgentByTypeAndId(
                                                                                                                                                                                                                                                                                                                                                                                                                                                          agentType: AgentType,
                                                                                                                                                                                                                                                                                                                                                                                                                                                          agentId: string,
                                                                                                                                                                                                                                                                                                                                                                                                                                                      ): Promise<AmConfigEntityInterface>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                      readAgentGroup(groupId: string): Promise<AmConfigEntityInterface>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                      readAgentGroups(): Promise<AmConfigEntityInterface[]>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                      readAgents(globalConfig: boolean): Promise<AmConfigEntityInterface[]>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                      readIdentityGatewayAgent(
                                                                                                                                                                                                                                                                                                                                                                                                                                                          gatewayId: string,
                                                                                                                                                                                                                                                                                                                                                                                                                                                      ): Promise<AmConfigEntityInterface>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                      readIdentityGatewayAgents(): Promise<AmConfigEntityInterface[]>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                      readJavaAgent(agentId: string): Promise<AmConfigEntityInterface>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                      readJavaAgents(): Promise<AmConfigEntityInterface[]>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                      readWebAgent(agentId: string): Promise<AmConfigEntityInterface>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                      readWebAgents(): Promise<AmConfigEntityInterface[]>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                      updateIdentityGatewayAgent(
                                                                                                                                                                                                                                                                                                                                                                                                                                                          gatewayId: string,
                                                                                                                                                                                                                                                                                                                                                                                                                                                          gatewayData: AmConfigEntityInterface,
                                                                                                                                                                                                                                                                                                                                                                                                                                                      ): Promise<AmConfigEntityInterface>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                      updateJavaAgent(
                                                                                                                                                                                                                                                                                                                                                                                                                                                          agentId: string,
                                                                                                                                                                                                                                                                                                                                                                                                                                                          agentData: AmConfigEntityInterface,
                                                                                                                                                                                                                                                                                                                                                                                                                                                      ): Promise<AmConfigEntityInterface>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                      updateWebAgent(
                                                                                                                                                                                                                                                                                                                                                                                                                                                          agentId: string,
                                                                                                                                                                                                                                                                                                                                                                                                                                                          agentData: AmConfigEntityInterface,
                                                                                                                                                                                                                                                                                                                                                                                                                                                      ): Promise<AmConfigEntityInterface>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                  }
                                                                                                                                                                                                                                                                                                                                                                                                                                                  Index

                                                                                                                                                                                                                                                                                                                                                                                                                                                  Methods

                                                                                                                                                                                                                                                                                                                                                                                                                                                  • Delete agent

                                                                                                                                                                                                                                                                                                                                                                                                                                                    Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                    • agentId: string

                                                                                                                                                                                                                                                                                                                                                                                                                                                      agent id/name

                                                                                                                                                                                                                                                                                                                                                                                                                                                      -

                                                                                                                                                                                                                                                                                                                                                                                                                                                    Returns Promise<void>

                                                                                                                                                                                                                                                                                                                                                                                                                                                  • Delete all agents

                                                                                                                                                                                                                                                                                                                                                                                                                                                    -

                                                                                                                                                                                                                                                                                                                                                                                                                                                    Returns Promise<void>

                                                                                                                                                                                                                                                                                                                                                                                                                                                  • Delete identity gateway agent

                                                                                                                                                                                                                                                                                                                                                                                                                                                    +

                                                                                                                                                                                                                                                                                                                                                                                                                                                  Returns Promise<void>

                                                                                                                                                                                                                                                                                                                                                                                                                                                  • Delete all agents

                                                                                                                                                                                                                                                                                                                                                                                                                                                    +

                                                                                                                                                                                                                                                                                                                                                                                                                                                    Returns Promise<void>

                                                                                                                                                                                                                                                                                                                                                                                                                                                  • Delete identity gateway agent

                                                                                                                                                                                                                                                                                                                                                                                                                                                    Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                    • agentId: string

                                                                                                                                                                                                                                                                                                                                                                                                                                                      agent id/name

                                                                                                                                                                                                                                                                                                                                                                                                                                                      -

                                                                                                                                                                                                                                                                                                                                                                                                                                                    Returns Promise<void>

                                                                                                                                                                                                                                                                                                                                                                                                                                                  • Delete all identity gateway agents

                                                                                                                                                                                                                                                                                                                                                                                                                                                    -

                                                                                                                                                                                                                                                                                                                                                                                                                                                    Returns Promise<void>

                                                                                                                                                                                                                                                                                                                                                                                                                                                  • Delete java agent

                                                                                                                                                                                                                                                                                                                                                                                                                                                    +

                                                                                                                                                                                                                                                                                                                                                                                                                                                  Returns Promise<void>

                                                                                                                                                                                                                                                                                                                                                                                                                                                  • Delete all identity gateway agents

                                                                                                                                                                                                                                                                                                                                                                                                                                                    +

                                                                                                                                                                                                                                                                                                                                                                                                                                                    Returns Promise<void>

                                                                                                                                                                                                                                                                                                                                                                                                                                                  • Delete java agent

                                                                                                                                                                                                                                                                                                                                                                                                                                                    Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                    • agentId: string

                                                                                                                                                                                                                                                                                                                                                                                                                                                      agent id/name

                                                                                                                                                                                                                                                                                                                                                                                                                                                      -

                                                                                                                                                                                                                                                                                                                                                                                                                                                    Returns Promise<void>

                                                                                                                                                                                                                                                                                                                                                                                                                                                  • Delete all java agents

                                                                                                                                                                                                                                                                                                                                                                                                                                                    -

                                                                                                                                                                                                                                                                                                                                                                                                                                                    Returns Promise<void>

                                                                                                                                                                                                                                                                                                                                                                                                                                                  • Delete web agent

                                                                                                                                                                                                                                                                                                                                                                                                                                                    +

                                                                                                                                                                                                                                                                                                                                                                                                                                                  Returns Promise<void>

                                                                                                                                                                                                                                                                                                                                                                                                                                                  Returns Promise<void>

                                                                                                                                                                                                                                                                                                                                                                                                                                                  Returns Promise<void>

                                                                                                                                                                                                                                                                                                                                                                                                                                                  Returns Promise<void>

                                                                                                                                                                                                                                                                                                                                                                                                                                                  Returns Promise<void>

                                                                                                                                                                                                                                                                                                                                                                                                                                                  Deprecated

                                                                                                                                                                                                                                                                                                                                                                                                                                                  Deprecated

                                                                                                                                                                                                                                                                                                                                                                                                                                                  • Get agent by type and id

                                                                                                                                                                                                                                                                                                                                                                                                                                                    Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                    • agentType: AgentType

                                                                                                                                                                                                                                                                                                                                                                                                                                                      agent type (IdentityGatewayAgent, J2EEAgent, WebAgent)

                                                                                                                                                                                                                                                                                                                                                                                                                                                    • agentId: string

                                                                                                                                                                                                                                                                                                                                                                                                                                                      agent id/name

                                                                                                                                                                                                                                                                                                                                                                                                                                                    Returns Promise<AmConfigEntityInterface>

                                                                                                                                                                                                                                                                                                                                                                                                                                                    a promise that resolves to an agent object

                                                                                                                                                                                                                                                                                                                                                                                                                                                    @@ -204,52 +204,52 @@
                                                                                                                                                                                                                                                                                                                                                                                                                                                    readAgentByTypeAndId(agentType: AgentType, agentId: string): Promise<AgentSkeleton>
                                                                                                                                                                                                                                                                                                                                                                                                                                                     
                                                                                                                                                                                                                                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                                                                                                                                                                                                                                  • Update or create identity gateway agent

                                                                                                                                                                                                                                                                                                                                                                                                                                                    Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                    Returns Promise<AmConfigEntityInterface>

                                                                                                                                                                                                                                                                                                                                                                                                                                                    a promise that resolves to an object containing an IdentityGatewayAgent object

                                                                                                                                                                                                                                                                                                                                                                                                                                                    @@ -257,7 +257,7 @@
                                                                                                                                                                                                                                                                                                                                                                                                                                                    updateIdentityGatewayAgent(gatewayId: string, gatewayData: AgentSkeleton): Promise<AgentSkeleton>
                                                                                                                                                                                                                                                                                                                                                                                                                                                    createIdentityGatewayAgent(gatewayId: string, gatewayData: AgentSkeleton): Promise<AgentSkeleton>
                                                                                                                                                                                                                                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                                                                                                                                                                                                                                  • Update or create java agent

                                                                                                                                                                                                                                                                                                                                                                                                                                                    Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                    Returns Promise<AmConfigEntityInterface>

                                                                                                                                                                                                                                                                                                                                                                                                                                                    a promise that resolves to an object containing an java agent object

                                                                                                                                                                                                                                                                                                                                                                                                                                                    @@ -265,7 +265,7 @@
                                                                                                                                                                                                                                                                                                                                                                                                                                                    updateJavaAgent(agentId: string, agentData: AgentSkeleton): Promise<AgentSkeleton>
                                                                                                                                                                                                                                                                                                                                                                                                                                                    createJavaAgent(agentId: string, agentData: AgentSkeleton): Promise<AgentSkeleton>
                                                                                                                                                                                                                                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                                                                                                                                                                                                                                  • Update or create web agent

                                                                                                                                                                                                                                                                                                                                                                                                                                                    Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                    Returns Promise<AmConfigEntityInterface>

                                                                                                                                                                                                                                                                                                                                                                                                                                                    a promise that resolves to an object containing an WebAgent object

                                                                                                                                                                                                                                                                                                                                                                                                                                                    @@ -273,4 +273,4 @@
                                                                                                                                                                                                                                                                                                                                                                                                                                                    updateWebAgent(agentId: string, agentData: AgentSkeleton): Promise<AgentSkeleton>
                                                                                                                                                                                                                                                                                                                                                                                                                                                    createWebAgent(agentId: string, agentData: AgentSkeleton): Promise<AgentSkeleton>
                                                                                                                                                                                                                                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                                                                                                                                                  diff --git a/docs/types/Reference.AgentSkeleton.html b/docs/types/Reference.AgentSkeleton.html index 922c6330e..9b4c1e07b 100644 --- a/docs/types/Reference.AgentSkeleton.html +++ b/docs/types/Reference.AgentSkeleton.html @@ -1 +1 @@ -AgentSkeleton | Frodo Library - v4.0.0-10
                                                                                                                                                                                                                                                                                                                                                                                                                                                  Frodo Library - v4.0.0-10
                                                                                                                                                                                                                                                                                                                                                                                                                                                    Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                                                    Type Alias AgentSkeleton

                                                                                                                                                                                                                                                                                                                                                                                                                                                    +AgentSkeleton | Frodo Library - v4.0.0-11
                                                                                                                                                                                                                                                                                                                                                                                                                                                    Frodo Library - v4.0.0-11
                                                                                                                                                                                                                                                                                                                                                                                                                                                      Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                                                      Type Alias AgentSkeleton

                                                                                                                                                                                                                                                                                                                                                                                                                                                      diff --git a/docs/types/Reference.AgentType.html b/docs/types/Reference.AgentType.html index 27fa7a9ff..f74d1d397 100644 --- a/docs/types/Reference.AgentType.html +++ b/docs/types/Reference.AgentType.html @@ -1 +1 @@ -AgentType | Frodo Library - v4.0.0-10
                                                                                                                                                                                                                                                                                                                                                                                                                                                      Frodo Library - v4.0.0-10
                                                                                                                                                                                                                                                                                                                                                                                                                                                        Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                                                        Type Alias AgentType

                                                                                                                                                                                                                                                                                                                                                                                                                                                        AgentType:
                                                                                                                                                                                                                                                                                                                                                                                                                                                            | PolicyAgentType
                                                                                                                                                                                                                                                                                                                                                                                                                                                            | GatewayAgentType
                                                                                                                                                                                                                                                                                                                                                                                                                                                            | JavaAgentType
                                                                                                                                                                                                                                                                                                                                                                                                                                                            | OAuth2ThingType
                                                                                                                                                                                                                                                                                                                                                                                                                                                            | RemoteConsentAgentType
                                                                                                                                                                                                                                                                                                                                                                                                                                                            | SharedAgentType
                                                                                                                                                                                                                                                                                                                                                                                                                                                            | SoapSTSAgentType
                                                                                                                                                                                                                                                                                                                                                                                                                                                            | SoftwarePublisherType
                                                                                                                                                                                                                                                                                                                                                                                                                                                            | WebAgentType
                                                                                                                                                                                                                                                                                                                                                                                                                                                            | EntityType
                                                                                                                                                                                                                                                                                                                                                                                                                                                        +AgentType | Frodo Library - v4.0.0-11
                                                                                                                                                                                                                                                                                                                                                                                                                                                        Frodo Library - v4.0.0-11
                                                                                                                                                                                                                                                                                                                                                                                                                                                          Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                                                          Type Alias AgentType

                                                                                                                                                                                                                                                                                                                                                                                                                                                          AgentType:
                                                                                                                                                                                                                                                                                                                                                                                                                                                              | PolicyAgentType
                                                                                                                                                                                                                                                                                                                                                                                                                                                              | GatewayAgentType
                                                                                                                                                                                                                                                                                                                                                                                                                                                              | JavaAgentType
                                                                                                                                                                                                                                                                                                                                                                                                                                                              | OAuth2ThingType
                                                                                                                                                                                                                                                                                                                                                                                                                                                              | RemoteConsentAgentType
                                                                                                                                                                                                                                                                                                                                                                                                                                                              | SharedAgentType
                                                                                                                                                                                                                                                                                                                                                                                                                                                              | SoapSTSAgentType
                                                                                                                                                                                                                                                                                                                                                                                                                                                              | SoftwarePublisherType
                                                                                                                                                                                                                                                                                                                                                                                                                                                              | WebAgentType
                                                                                                                                                                                                                                                                                                                                                                                                                                                              | EntityType
                                                                                                                                                                                                                                                                                                                                                                                                                                                          diff --git a/docs/types/Reference.AmServiceSkeleton.html b/docs/types/Reference.AmServiceSkeleton.html index 1d9ed6360..5a972c6d7 100644 --- a/docs/types/Reference.AmServiceSkeleton.html +++ b/docs/types/Reference.AmServiceSkeleton.html @@ -1 +1 @@ -AmServiceSkeleton | Frodo Library - v4.0.0-10
                                                                                                                                                                                                                                                                                                                                                                                                                                                          Frodo Library - v4.0.0-10
                                                                                                                                                                                                                                                                                                                                                                                                                                                            Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                                                            Type Alias AmServiceSkeleton

                                                                                                                                                                                                                                                                                                                                                                                                                                                            AmServiceSkeleton: AmConfigEntityInterface & { [key: string]: any }
                                                                                                                                                                                                                                                                                                                                                                                                                                                            +AmServiceSkeleton | Frodo Library - v4.0.0-11
                                                                                                                                                                                                                                                                                                                                                                                                                                                            Frodo Library - v4.0.0-11
                                                                                                                                                                                                                                                                                                                                                                                                                                                              Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                                                              Type Alias AmServiceSkeleton

                                                                                                                                                                                                                                                                                                                                                                                                                                                              AmServiceSkeleton: AmConfigEntityInterface & { [key: string]: any }
                                                                                                                                                                                                                                                                                                                                                                                                                                                              diff --git a/docs/types/Reference.Application.html b/docs/types/Reference.Application.html index 47b2000ea..041cb4054 100644 --- a/docs/types/Reference.Application.html +++ b/docs/types/Reference.Application.html @@ -1,4 +1,4 @@ -Application | Frodo Library - v4.0.0-10
                                                                                                                                                                                                                                                                                                                                                                                                                                                              Frodo Library - v4.0.0-10
                                                                                                                                                                                                                                                                                                                                                                                                                                                                Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                                                                Type Alias Application

                                                                                                                                                                                                                                                                                                                                                                                                                                                                type Application = {
                                                                                                                                                                                                                                                                                                                                                                                                                                                                    createApplication(
                                                                                                                                                                                                                                                                                                                                                                                                                                                                        applicationId: string,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                        applicationData: ApplicationSkeleton,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                    ): Promise<ApplicationSkeleton>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                    createApplicationExportTemplate(): ApplicationExportInterface;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                    deleteApplication(
                                                                                                                                                                                                                                                                                                                                                                                                                                                                        applicationId: string,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                        deep?: boolean,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                    ): Promise<ApplicationSkeleton>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                    deleteApplicationByName(
                                                                                                                                                                                                                                                                                                                                                                                                                                                                        applicationName: string,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                        deep?: boolean,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                    ): Promise<ApplicationSkeleton>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                    deleteApplications(deep?: boolean): Promise<ApplicationSkeleton[]>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                    exportApplication(
                                                                                                                                                                                                                                                                                                                                                                                                                                                                        applicationId: string,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                        options: ApplicationExportOptions,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                    ): Promise<ApplicationExportInterface>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                    exportApplicationByName(
                                                                                                                                                                                                                                                                                                                                                                                                                                                                        applicationName: string,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                        options: ApplicationExportOptions,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                    ): Promise<ApplicationExportInterface>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                    exportApplications(
                                                                                                                                                                                                                                                                                                                                                                                                                                                                        options?: ApplicationExportOptions,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                    ): Promise<ApplicationExportInterface>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                    getRealmManagedApplication(): string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                    importApplication(
                                                                                                                                                                                                                                                                                                                                                                                                                                                                        applicationId: string,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                        importData: ApplicationExportInterface,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                        options: ApplicationImportOptions,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                    ): Promise<ApplicationSkeleton>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                    importApplicationByName(
                                                                                                                                                                                                                                                                                                                                                                                                                                                                        applicationName: string,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                        importData: ApplicationExportInterface,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                        options: ApplicationImportOptions,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                    ): Promise<ApplicationSkeleton>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                    importApplications(
                                                                                                                                                                                                                                                                                                                                                                                                                                                                        importData: ApplicationExportInterface,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                        options: ApplicationImportOptions,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                    ): Promise<ApplicationSkeleton[]>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                    importFirstApplication(
                                                                                                                                                                                                                                                                                                                                                                                                                                                                        importData: ApplicationExportInterface,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                        options: ApplicationImportOptions,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                    ): Promise<ApplicationSkeleton[]>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                    queryApplications(
                                                                                                                                                                                                                                                                                                                                                                                                                                                                        filter: string,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                        fields?: string[],
                                                                                                                                                                                                                                                                                                                                                                                                                                                                    ): Promise<ApplicationSkeleton[]>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                    readApplication(applicationId: string): Promise<ApplicationSkeleton>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                    readApplicationByName(
                                                                                                                                                                                                                                                                                                                                                                                                                                                                        applicationName: string,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                    ): Promise<ApplicationSkeleton>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                    readApplications(): Promise<ApplicationSkeleton[]>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                    updateApplication(
                                                                                                                                                                                                                                                                                                                                                                                                                                                                        applicationId: string,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                        applicationData: ApplicationSkeleton,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                    ): Promise<ApplicationSkeleton>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                }
                                                                                                                                                                                                                                                                                                                                                                                                                                                                Index

                                                                                                                                                                                                                                                                                                                                                                                                                                                                Methods

                                                                                                                                                                                                                                                                                                                                                                                                                                                                createApplication +Application | Frodo Library - v4.0.0-11
                                                                                                                                                                                                                                                                                                                                                                                                                                                                Frodo Library - v4.0.0-11
                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Type Alias Application

                                                                                                                                                                                                                                                                                                                                                                                                                                                                  type Application = {
                                                                                                                                                                                                                                                                                                                                                                                                                                                                      createApplication(
                                                                                                                                                                                                                                                                                                                                                                                                                                                                          applicationId: string,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                          applicationData: ApplicationSkeleton,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                      ): Promise<ApplicationSkeleton>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                      createApplicationExportTemplate(): ApplicationExportInterface;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                      deleteApplication(
                                                                                                                                                                                                                                                                                                                                                                                                                                                                          applicationId: string,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                          deep?: boolean,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                      ): Promise<ApplicationSkeleton>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                      deleteApplicationByName(
                                                                                                                                                                                                                                                                                                                                                                                                                                                                          applicationName: string,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                          deep?: boolean,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                      ): Promise<ApplicationSkeleton>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                      deleteApplications(deep?: boolean): Promise<ApplicationSkeleton[]>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                      exportApplication(
                                                                                                                                                                                                                                                                                                                                                                                                                                                                          applicationId: string,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                          options: ApplicationExportOptions,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                      ): Promise<ApplicationExportInterface>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                      exportApplicationByName(
                                                                                                                                                                                                                                                                                                                                                                                                                                                                          applicationName: string,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                          options: ApplicationExportOptions,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                      ): Promise<ApplicationExportInterface>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                      exportApplications(
                                                                                                                                                                                                                                                                                                                                                                                                                                                                          options?: ApplicationExportOptions,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                      ): Promise<ApplicationExportInterface>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                      getRealmManagedApplication(): string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                      importApplication(
                                                                                                                                                                                                                                                                                                                                                                                                                                                                          applicationId: string,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                          importData: ApplicationExportInterface,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                          options: ApplicationImportOptions,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                      ): Promise<ApplicationSkeleton>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                      importApplicationByName(
                                                                                                                                                                                                                                                                                                                                                                                                                                                                          applicationName: string,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                          importData: ApplicationExportInterface,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                          options: ApplicationImportOptions,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                      ): Promise<ApplicationSkeleton>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                      importApplications(
                                                                                                                                                                                                                                                                                                                                                                                                                                                                          importData: ApplicationExportInterface,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                          options: ApplicationImportOptions,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                      ): Promise<ApplicationSkeleton[]>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                      importFirstApplication(
                                                                                                                                                                                                                                                                                                                                                                                                                                                                          importData: ApplicationExportInterface,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                          options: ApplicationImportOptions,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                      ): Promise<ApplicationSkeleton[]>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                      queryApplications(
                                                                                                                                                                                                                                                                                                                                                                                                                                                                          filter: string,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                          fields?: string[],
                                                                                                                                                                                                                                                                                                                                                                                                                                                                      ): Promise<ApplicationSkeleton[]>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                      readApplication(applicationId: string): Promise<ApplicationSkeleton>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                      readApplicationByName(
                                                                                                                                                                                                                                                                                                                                                                                                                                                                          applicationName: string,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                      ): Promise<ApplicationSkeleton>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                      readApplications(): Promise<ApplicationSkeleton[]>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                      updateApplication(
                                                                                                                                                                                                                                                                                                                                                                                                                                                                          applicationId: string,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                          applicationData: ApplicationSkeleton,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                      ): Promise<ApplicationSkeleton>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                  }
                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Index

                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Methods

                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Returns Promise<ApplicationSkeleton>

                                                                                                                                                                                                                                                                                                                                                                                                                                                                  a promise that resolves to an application object

                                                                                                                                                                                                                                                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • Delete application

                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • applicationId: string

                                                                                                                                                                                                                                                                                                                                                                                                                                                                      application uuid

                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • Optionaldeep: boolean

                                                                                                                                                                                                                                                                                                                                                                                                                                                                      deep delete (remove dependencies)

                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Returns Promise<ApplicationSkeleton>

                                                                                                                                                                                                                                                                                                                                                                                                                                                                    a promise that resolves to an application object

                                                                                                                                                                                                                                                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • Delete application by name

                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • applicationName: string

                                                                                                                                                                                                                                                                                                                                                                                                                                                                      application name

                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • Optionaldeep: boolean

                                                                                                                                                                                                                                                                                                                                                                                                                                                                      deep delete (remove dependencies)

                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Returns Promise<ApplicationSkeleton>

                                                                                                                                                                                                                                                                                                                                                                                                                                                                    a promise that resolves to an application object

                                                                                                                                                                                                                                                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • Get application managed object type

                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Returns string

                                                                                                                                                                                                                                                                                                                                                                                                                                                                    application managed object type in this realm

                                                                                                                                                                                                                                                                                                                                                                                                                                                                    -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Returns Promise<ApplicationSkeleton[]>

                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Returns Promise<ApplicationSkeleton[]>

                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Returns Promise<ApplicationSkeleton[]>

                                                                                                                                                                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                  diff --git a/docs/types/Reference.ApplicationExportOptions.html b/docs/types/Reference.ApplicationExportOptions.html index 0ecc652ff..e527e455b 100644 --- a/docs/types/Reference.ApplicationExportOptions.html +++ b/docs/types/Reference.ApplicationExportOptions.html @@ -1,6 +1,6 @@ -ApplicationExportOptions | Frodo Library - v4.0.0-10
                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Frodo Library - v4.0.0-10
                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Type Alias ApplicationExportOptions

                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Application export options

                                                                                                                                                                                                                                                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                    type ApplicationExportOptions = {
                                                                                                                                                                                                                                                                                                                                                                                                                                                                        deps: boolean;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                        useStringArrays: boolean;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                    }
                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Index

                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Properties

                                                                                                                                                                                                                                                                                                                                                                                                                                                                    deps +ApplicationExportOptions | Frodo Library - v4.0.0-11
                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Frodo Library - v4.0.0-11
                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Type Alias ApplicationExportOptions

                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Application export options

                                                                                                                                                                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                      type ApplicationExportOptions = {
                                                                                                                                                                                                                                                                                                                                                                                                                                                                          deps: boolean;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                          useStringArrays: boolean;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                      }
                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Index

                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Properties

                                                                                                                                                                                                                                                                                                                                                                                                                                                                      deps: boolean

                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Include any dependencies (scripts, oauth2 clients, saml providers, circles of trust, etc).

                                                                                                                                                                                                                                                                                                                                                                                                                                                                      -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                      useStringArrays: boolean

                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Use string arrays to store multi-line text in scripts.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                      -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                      useStringArrays: boolean

                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Use string arrays to store multi-line text in scripts.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                      diff --git a/docs/types/Reference.ApplicationImportOptions.html b/docs/types/Reference.ApplicationImportOptions.html index 2704af10a..e95bf0ae6 100644 --- a/docs/types/Reference.ApplicationImportOptions.html +++ b/docs/types/Reference.ApplicationImportOptions.html @@ -1,4 +1,4 @@ -ApplicationImportOptions | Frodo Library - v4.0.0-10
                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Frodo Library - v4.0.0-10
                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Type Alias ApplicationImportOptions

                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Application export options

                                                                                                                                                                                                                                                                                                                                                                                                                                                                        -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                        type ApplicationImportOptions = {
                                                                                                                                                                                                                                                                                                                                                                                                                                                                            deps: boolean;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                        }
                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Index

                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Properties

                                                                                                                                                                                                                                                                                                                                                                                                                                                                        deps +ApplicationImportOptions | Frodo Library - v4.0.0-11
                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Frodo Library - v4.0.0-11
                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Type Alias ApplicationImportOptions

                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Application export options

                                                                                                                                                                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                          type ApplicationImportOptions = {
                                                                                                                                                                                                                                                                                                                                                                                                                                                                              deps: boolean;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                          }
                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Index

                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Properties

                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Properties

                                                                                                                                                                                                                                                                                                                                                                                                                                                                          deps: boolean

                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Import any dependencies (scripts).

                                                                                                                                                                                                                                                                                                                                                                                                                                                                          -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                          diff --git a/docs/types/Reference.ApplicationSkeleton.html b/docs/types/Reference.ApplicationSkeleton.html index 523caa50d..b361ae1f7 100644 --- a/docs/types/Reference.ApplicationSkeleton.html +++ b/docs/types/Reference.ApplicationSkeleton.html @@ -1 +1 @@ -ApplicationSkeleton | Frodo Library - v4.0.0-10
                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Frodo Library - v4.0.0-10
                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Type Alias ApplicationSkeleton

                                                                                                                                                                                                                                                                                                                                                                                                                                                                            ApplicationSkeleton: IdObjectSkeletonInterface & {
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                authoritative: boolean;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                connectorId: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                description: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                icon: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                mappingNames: string[];
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                members: any;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                name: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                owners: any;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                roles: any;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                ssoEntities: {
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    idpLocation: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    idpPrivateId: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    spLocation: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    spPrivate: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                };
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                templateName: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                templateVersion: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                uiConfig: object;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                url: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                            }
                                                                                                                                                                                                                                                                                                                                                                                                                                                                            +ApplicationSkeleton | Frodo Library - v4.0.0-11
                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Frodo Library - v4.0.0-11
                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Type Alias ApplicationSkeleton

                                                                                                                                                                                                                                                                                                                                                                                                                                                                              ApplicationSkeleton: IdObjectSkeletonInterface & {
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  authoritative: boolean;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  connectorId: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  description: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  icon: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  mappingNames: string[];
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  members: any;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  name: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  owners: any;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  roles: any;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  ssoEntities: {
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      idpLocation: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      idpPrivateId: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      spLocation: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      spPrivate: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  };
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  templateName: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  templateVersion: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  uiConfig: object;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  url: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                              }
                                                                                                                                                                                                                                                                                                                                                                                                                                                                              diff --git a/docs/types/Reference.Authenticate.html b/docs/types/Reference.Authenticate.html index 191beeeec..eb53acba6 100644 --- a/docs/types/Reference.Authenticate.html +++ b/docs/types/Reference.Authenticate.html @@ -1,4 +1,4 @@ -Authenticate | Frodo Library - v4.0.0-10
                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Frodo Library - v4.0.0-10
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Type Alias Authenticate

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                type Authenticate = {
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    getAccessTokenForServiceAccount(
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        saId?: string,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        saJwk?: JwkRsa,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    ): Promise<string>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    getTokens(
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        forceLoginAsUser?: boolean,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        autoRefresh?: boolean,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        types?: string[],
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        callbackHandler?: CallbackHandler,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    ): Promise<Tokens>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                }
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Index

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Methods

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                getTokens +Authenticate | Frodo Library - v4.0.0-11
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Frodo Library - v4.0.0-11
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Type Alias Authenticate

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  type Authenticate = {
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      getAccessTokenForServiceAccount(
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          saId?: string,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          saJwk?: JwkRsa,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      ): Promise<string>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      getTokens(
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          forceLoginAsUser?: boolean,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          autoRefresh?: boolean,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          types?: string[],
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          callbackHandler?: CallbackHandler,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      ): Promise<Tokens>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  }
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Index

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Methods

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • Get tokens and store them in State

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • OptionalforceLoginAsUser: boolean

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      true to force login as user even if a service account or Amster account is available (default: false)

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      @@ -6,7 +6,7 @@
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • Optionaltypes: string[]

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Array of supported deployment types. The function will throw an error if an unsupported type is detected (default: ['classic', 'cloud', 'forgeops'])

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • OptionalcallbackHandler: CallbackHandler

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      function allowing the library to collect responses from the user through callbacks

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Returns Promise<Tokens>

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    object containing the tokens

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Deprecated

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Deprecated

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • Get access token for service account

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • OptionalsaId: string

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      optional service account id

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • OptionalsaJwk: JwkRsa

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      optional service account JWK

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Returns Promise<string>

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Access token or null

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    @@ -14,4 +14,4 @@
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    getTokens(): Promise<boolean>
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                     
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  diff --git a/docs/types/Reference.AuthenticationSettings.html b/docs/types/Reference.AuthenticationSettings.html index ddc420aba..bff15ca6a 100644 --- a/docs/types/Reference.AuthenticationSettings.html +++ b/docs/types/Reference.AuthenticationSettings.html @@ -1,18 +1,18 @@ -AuthenticationSettings | Frodo Library - v4.0.0-10
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Frodo Library - v4.0.0-10
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Type Alias AuthenticationSettings

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    type AuthenticationSettings = {
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        exportAuthenticationSettings(
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            globalConfig: boolean,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        ): Promise<AuthenticationSettingsExportInterface>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        importAuthenticationSettings(
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            importData: AuthenticationSettingsExportInterface,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            globalConfig: boolean,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        ): Promise<AuthenticationSettingsSkeleton>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        readAuthenticationSettings(
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            globalConfig: boolean,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        ): Promise<AuthenticationSettingsSkeleton>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        updateAuthenticationSettings(
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            settings: AuthenticationSettingsSkeleton,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            globalConfig: boolean,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        ): Promise<AuthenticationSettingsSkeleton>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    }
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Index

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Methods

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    exportAuthenticationSettings +AuthenticationSettings | Frodo Library - v4.0.0-11
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Frodo Library - v4.0.0-11
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Type Alias AuthenticationSettings

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      type AuthenticationSettings = {
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          exportAuthenticationSettings(
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              globalConfig: boolean,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          ): Promise<AuthenticationSettingsExportInterface>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          importAuthenticationSettings(
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              importData: AuthenticationSettingsExportInterface,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              globalConfig: boolean,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          ): Promise<AuthenticationSettingsSkeleton>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          readAuthenticationSettings(
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              globalConfig: boolean,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          ): Promise<AuthenticationSettingsSkeleton>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          updateAuthenticationSettings(
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              settings: AuthenticationSettingsSkeleton,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              globalConfig: boolean,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          ): Promise<AuthenticationSettingsSkeleton>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      }
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Index

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Methods

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Returns Promise<AuthenticationSettingsSkeleton>

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      diff --git a/docs/types/Reference.AuthenticationSettingsSkeleton.html b/docs/types/Reference.AuthenticationSettingsSkeleton.html index 44d2b3261..a086a448b 100644 --- a/docs/types/Reference.AuthenticationSettingsSkeleton.html +++ b/docs/types/Reference.AuthenticationSettingsSkeleton.html @@ -1 +1 @@ -AuthenticationSettingsSkeleton | Frodo Library - v4.0.0-10
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Frodo Library - v4.0.0-10
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Type Alias AuthenticationSettingsSkeleton

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        AuthenticationSettingsSkeleton: IdObjectSkeletonInterface & {
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            _id: "";
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            _type: { _id: "EMPTY"; collection: false; name: "Core" };
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        }
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        +AuthenticationSettingsSkeleton | Frodo Library - v4.0.0-11
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Frodo Library - v4.0.0-11
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Type Alias AuthenticationSettingsSkeleton

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          AuthenticationSettingsSkeleton: IdObjectSkeletonInterface & {
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              _id: "";
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              _type: { _id: "EMPTY"; collection: false; name: "Core" };
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          }
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          diff --git a/docs/types/Reference.Base64.html b/docs/types/Reference.Base64.html index cc8111a61..ec218d8c0 100644 --- a/docs/types/Reference.Base64.html +++ b/docs/types/Reference.Base64.html @@ -1,6 +1,6 @@ -Base64 | Frodo Library - v4.0.0-10
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Frodo Library - v4.0.0-10
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Type Alias Base64

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            type Base64 = {
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                decodeBase64(input: string): string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                decodeBase64Url(input: string): string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                encodeBase64(input: string, padding?: boolean): string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                encodeBase64Url(input: string): string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                isBase64Encoded(input: any): boolean;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            }
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Index

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Methods

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            decodeBase64 +Base64 | Frodo Library - v4.0.0-11
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Frodo Library - v4.0.0-11
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Type Alias Base64

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              type Base64 = {
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  decodeBase64(input: string): string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  decodeBase64Url(input: string): string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  encodeBase64(input: string, padding?: boolean): string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  encodeBase64Url(input: string): string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  isBase64Encoded(input: any): boolean;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              }
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Index

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Methods

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • input: string
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • Optionalpadding: boolean

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Returns string

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Methods

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • input: string
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • Optionalpadding: boolean

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Returns string

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              diff --git a/docs/types/Reference.Callback.html b/docs/types/Reference.Callback.html index 3405a9a0a..b43ef57e9 100644 --- a/docs/types/Reference.Callback.html +++ b/docs/types/Reference.Callback.html @@ -1,4 +1,4 @@ -Callback | Frodo Library - v4.0.0-10
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Frodo Library - v4.0.0-10
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Type Alias Callback

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                type Callback = {
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    input: CallbackKeyValuePair[];
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    output: CallbackKeyValuePair[];
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    type: CallbackType;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                }
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Index

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Properties

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                input +Callback | Frodo Library - v4.0.0-11
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Frodo Library - v4.0.0-11
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Type Alias Callback

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  type Callback = {
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      input: CallbackKeyValuePair[];
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      output: CallbackKeyValuePair[];
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      type: CallbackType;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  }
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Index

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Properties

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Properties

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Properties

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  diff --git a/docs/types/Reference.CallbackHandler.html b/docs/types/Reference.CallbackHandler.html index 962f4c133..50f30f514 100644 --- a/docs/types/Reference.CallbackHandler.html +++ b/docs/types/Reference.CallbackHandler.html @@ -1 +1 @@ -CallbackHandler | Frodo Library - v4.0.0-10
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Frodo Library - v4.0.0-10
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Type Alias CallbackHandler

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    CallbackHandler: (callback: Callback) => Callback

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Type Declaration

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    +CallbackHandler | Frodo Library - v4.0.0-11
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Frodo Library - v4.0.0-11
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Type Alias CallbackHandler

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      CallbackHandler: (callback: Callback) => Callback

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Type Declaration

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      diff --git a/docs/types/Reference.CallbackKeyValuePair.html b/docs/types/Reference.CallbackKeyValuePair.html index 62832efa1..d757c84a9 100644 --- a/docs/types/Reference.CallbackKeyValuePair.html +++ b/docs/types/Reference.CallbackKeyValuePair.html @@ -1,3 +1,3 @@ -CallbackKeyValuePair | Frodo Library - v4.0.0-10
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Frodo Library - v4.0.0-10
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Type Alias CallbackKeyValuePair

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        type CallbackKeyValuePair = {
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            name: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            value: any;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        }
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Index

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Properties

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        name +CallbackKeyValuePair | Frodo Library - v4.0.0-11
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Frodo Library - v4.0.0-11
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Type Alias CallbackKeyValuePair

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          type CallbackKeyValuePair = {
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              name: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              value: any;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          }
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Index

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Properties

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Properties

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          name: string
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          value: any
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Properties

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          name: string
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          value: any
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          diff --git a/docs/types/Reference.CallbackType.html b/docs/types/Reference.CallbackType.html index 76b5c8f95..c1cfca11e 100644 --- a/docs/types/Reference.CallbackType.html +++ b/docs/types/Reference.CallbackType.html @@ -1 +1 @@ -CallbackType | Frodo Library - v4.0.0-10
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Frodo Library - v4.0.0-10
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Type Alias CallbackType

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            CallbackType:
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                | "NameCallback"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                | "PasswordCallback"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                | "TextInputCallback"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                | "HiddenValueCallback"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                | "SelectIdPCallback"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            +CallbackType | Frodo Library - v4.0.0-11
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Frodo Library - v4.0.0-11
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Type Alias CallbackType

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              CallbackType:
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  | "NameCallback"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  | "PasswordCallback"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  | "TextInputCallback"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  | "HiddenValueCallback"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  | "SelectIdPCallback"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              diff --git a/docs/types/Reference.CircleOfTrustSkeleton.html b/docs/types/Reference.CircleOfTrustSkeleton.html index 6ba725bea..e8aed2bae 100644 --- a/docs/types/Reference.CircleOfTrustSkeleton.html +++ b/docs/types/Reference.CircleOfTrustSkeleton.html @@ -1 +1 @@ -CircleOfTrustSkeleton | Frodo Library - v4.0.0-10
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Frodo Library - v4.0.0-10
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Type Alias CircleOfTrustSkeleton

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                CircleOfTrustSkeleton: AmConfigEntityInterface & {
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    status?: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    trustedProviders?: string[];
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                }
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                +CircleOfTrustSkeleton | Frodo Library - v4.0.0-11
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Frodo Library - v4.0.0-11
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Type Alias CircleOfTrustSkeleton

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  CircleOfTrustSkeleton: AmConfigEntityInterface & {
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      status?: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      trustedProviders?: string[];
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  }
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  diff --git a/docs/types/Reference.CirclesOfTrust.html b/docs/types/Reference.CirclesOfTrust.html index 437eb6fb5..30330234a 100644 --- a/docs/types/Reference.CirclesOfTrust.html +++ b/docs/types/Reference.CirclesOfTrust.html @@ -1,4 +1,4 @@ -CirclesOfTrust | Frodo Library - v4.0.0-10
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Frodo Library - v4.0.0-10
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Type Alias CirclesOfTrust

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    type CirclesOfTrust = {
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        createCircleOfTrust(
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            cotId?: string,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            cotData?: CircleOfTrustSkeleton,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        ): Promise<CircleOfTrustSkeleton>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        createCirclesOfTrustExportTemplate(): CirclesOfTrustExportInterface;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        deleteCircleOfTrust(cotId: string): Promise<CircleOfTrustSkeleton>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        deleteCirclesOfTrust(
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            entityProviders?: string[],
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        ): Promise<CircleOfTrustSkeleton[]>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        exportCircleOfTrust(cotId: string): Promise<CirclesOfTrustExportInterface>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        exportCirclesOfTrust(
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            entityProviders?: string[],
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        ): Promise<CirclesOfTrustExportInterface>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        getCircleOfTrust(cotId: string): Promise<CircleOfTrustSkeleton>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        getCirclesOfTrust(): Promise<CircleOfTrustSkeleton[]>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        importCircleOfTrust(
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            cotId: string,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            importData: CirclesOfTrustExportInterface,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        ): Promise<CircleOfTrustSkeleton>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        importCirclesOfTrust(
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            importData: CirclesOfTrustExportInterface,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            entityProviders?: string[],
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        ): Promise<CircleOfTrustSkeleton[]>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        importFirstCircleOfTrust(
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            importData: CirclesOfTrustExportInterface,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        ): Promise<CircleOfTrustSkeleton>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        readCircleOfTrust(cotId: string): Promise<CircleOfTrustSkeleton>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        readCirclesOfTrust(
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            entityProviders?: string[],
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        ): Promise<CircleOfTrustSkeleton[]>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        updateCircleOfTrust(
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            cotId: string,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            cotData: CircleOfTrustSkeleton,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        ): Promise<CircleOfTrustSkeleton>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    }
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Index

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Methods

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    createCircleOfTrust +CirclesOfTrust | Frodo Library - v4.0.0-11
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Frodo Library - v4.0.0-11
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Type Alias CirclesOfTrust

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      type CirclesOfTrust = {
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          createCircleOfTrust(
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              cotId?: string,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              cotData?: CircleOfTrustSkeleton,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          ): Promise<CircleOfTrustSkeleton>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          createCirclesOfTrustExportTemplate(): CirclesOfTrustExportInterface;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          deleteCircleOfTrust(cotId: string): Promise<CircleOfTrustSkeleton>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          deleteCirclesOfTrust(
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              entityProviders?: string[],
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          ): Promise<CircleOfTrustSkeleton[]>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          exportCircleOfTrust(cotId: string): Promise<CirclesOfTrustExportInterface>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          exportCirclesOfTrust(
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              entityProviders?: string[],
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          ): Promise<CirclesOfTrustExportInterface>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          getCircleOfTrust(cotId: string): Promise<CircleOfTrustSkeleton>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          getCirclesOfTrust(): Promise<CircleOfTrustSkeleton[]>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          importCircleOfTrust(
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              cotId: string,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              importData: CirclesOfTrustExportInterface,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          ): Promise<CircleOfTrustSkeleton>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          importCirclesOfTrust(
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              importData: CirclesOfTrustExportInterface,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              entityProviders?: string[],
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          ): Promise<CircleOfTrustSkeleton[]>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          importFirstCircleOfTrust(
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              importData: CirclesOfTrustExportInterface,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          ): Promise<CircleOfTrustSkeleton>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          readCircleOfTrust(cotId: string): Promise<CircleOfTrustSkeleton>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          readCirclesOfTrust(
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              entityProviders?: string[],
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          ): Promise<CircleOfTrustSkeleton[]>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          updateCircleOfTrust(
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              cotId: string,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              cotData: CircleOfTrustSkeleton,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          ): Promise<CircleOfTrustSkeleton>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      }
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Index

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Methods

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Returns Promise<CircleOfTrustSkeleton>

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • Delete circles of trust

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Returns Promise<CircleOfTrustSkeleton>

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Returns Promise<CircleOfTrustSkeleton[]>

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Returns Promise<CirclesOfTrustExportInterface>

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Returns Promise<CirclesOfTrustExportInterface>

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Returns Promise<CircleOfTrustSkeleton>

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Returns Promise<CircleOfTrustSkeleton[]>

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Deprecated

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Returns Promise<CircleOfTrustSkeleton>

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Deprecated

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      diff --git a/docs/types/Reference.Config.html b/docs/types/Reference.Config.html index e2f0cbdcc..4d8525791 100644 --- a/docs/types/Reference.Config.html +++ b/docs/types/Reference.Config.html @@ -1,11 +1,11 @@ -Config | Frodo Library - v4.0.0-10
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Frodo Library - v4.0.0-10
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Type Alias Config

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        type Config = {
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            exportFullConfiguration(
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                options: FullExportOptions,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                resultCallback: ResultCallback<any>,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            ): Promise<FullExportInterface>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            importFullConfiguration(
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                importData: FullExportInterface,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                options: FullImportOptions,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                resultCallback: ResultCallback<any>,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            ): Promise<(object | any[])[]>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        }
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Index

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Methods

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        exportFullConfiguration +Config | Frodo Library - v4.0.0-11
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Frodo Library - v4.0.0-11
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Type Alias Config

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          type Config = {
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              exportFullConfiguration(
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  options: FullExportOptions,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  resultCallback: ResultCallback<any>,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              ): Promise<FullExportInterface>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              importFullConfiguration(
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  importData: FullExportInterface,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  options: FullImportOptions,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  resultCallback: ResultCallback<any>,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              ): Promise<(object | any[])[]>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          }
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Index

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Methods

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Returns Promise<(object | any[])[]>

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          diff --git a/docs/types/Reference.ConnectionProfile.html b/docs/types/Reference.ConnectionProfile.html index 364d0d5eb..ca8abe4e0 100644 --- a/docs/types/Reference.ConnectionProfile.html +++ b/docs/types/Reference.ConnectionProfile.html @@ -1,4 +1,4 @@ -ConnectionProfile | Frodo Library - v4.0.0-10
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Frodo Library - v4.0.0-10
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Type Alias ConnectionProfile

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            type ConnectionProfile = {
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                addNewServiceAccount(): Promise<IdObjectSkeletonInterface>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                deleteConnectionProfile(host: string): void;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                deleteConnectionProfileAlias(host: string): void;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                findConnectionProfiles(
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    connectionProfiles: ConnectionsFileInterface,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    host: string,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                ): SecureConnectionProfileInterface[];
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                getConnectionProfile(): Promise<ConnectionProfileInterface>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                getConnectionProfileByHost(
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    host: string,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                ): Promise<ConnectionProfileInterface>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                getConnectionProfilesPath(): string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                initConnectionProfiles(): Promise<void>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                loadConnectionProfile(): Promise<boolean>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                loadConnectionProfileByHost(host: string): Promise<boolean>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                saveConnectionProfile(host: string): Promise<boolean>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                setConnectionProfileAlias(host: string, alias: string): void;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            }
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Index

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Methods

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            addNewServiceAccount +ConnectionProfile | Frodo Library - v4.0.0-11
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Frodo Library - v4.0.0-11
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Type Alias ConnectionProfile

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              type ConnectionProfile = {
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  addNewServiceAccount(): Promise<IdObjectSkeletonInterface>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  deleteConnectionProfile(host: string): void;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  deleteConnectionProfileAlias(host: string): void;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  findConnectionProfiles(
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      connectionProfiles: ConnectionsFileInterface,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      host: string,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  ): SecureConnectionProfileInterface[];
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  getConnectionProfile(): Promise<ConnectionProfileInterface>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  getConnectionProfileByHost(
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      host: string,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  ): Promise<ConnectionProfileInterface>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  getConnectionProfilesPath(): string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  initConnectionProfiles(): Promise<void>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  loadConnectionProfile(): Promise<boolean>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  loadConnectionProfileByHost(host: string): Promise<boolean>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  saveConnectionProfile(host: string): Promise<boolean>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  setConnectionProfileAlias(host: string, alias: string): void;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              }
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Index

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Methods

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • Delete connection profile

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • host: string

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  host tenant, host url, unique substring, or alias

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Returns void

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • Set an alias for an existing connection profile

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Returns void

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • Set an alias for an existing connection profile

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • host: string

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  host url, unique substring, or alias of existing connection profile

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Returns void

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Returns void

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • Get connection profiles file name

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Returns string

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                connection profiles file name

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • Initialize connection profiles

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                This method is called from app.ts and runs before any of the message handlers are registered. Therefore none of the Console message functions will produce any output.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Returns Promise<void>

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • Load a connection profile into library state

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Returns Promise<boolean>

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                A promise resolving to true if successful

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • Load a connection profile into library state

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • host: string

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  AM host URL, unique substring, or alias

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Returns Promise<boolean>

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                A promise resolving to true if successful

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • Save connection profile

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • host: string

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  host url for new profiles, unique substring or alias for existing profiles

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Returns Promise<boolean>

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                true if the operation succeeded, false otherwise

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • Set an alias for an existing connection profile

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • Set an alias for an existing connection profile

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • host: string

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  host url, unique substring, or alias of existing connection profile

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • alias: string

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  alias to be assigned to connection profile

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Returns void

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Returns void

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              diff --git a/docs/types/Reference.Connector.html b/docs/types/Reference.Connector.html index 1d3c1a9bd..fc2c2e8f8 100644 --- a/docs/types/Reference.Connector.html +++ b/docs/types/Reference.Connector.html @@ -1,4 +1,4 @@ -Connector | Frodo Library - v4.0.0-10
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Frodo Library - v4.0.0-10
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Type Alias Connector

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                type Connector = {
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    CONNECTOR_TYPE: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    createConnector(
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        connectorId: string,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        connectorData: ConnectorSkeleton,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    ): Promise<ConnectorSkeleton>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    createConnectorExportTemplate(): ConnectorExportInterface;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    deleteConnector(
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        connectorId: string,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        deep?: boolean,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    ): Promise<ConnectorSkeleton>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    deleteConnectors(deep?: boolean): Promise<ConnectorSkeleton[]>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    exportConnector(
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        connectorId: string,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        options?: ConnectorExportOptions,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    ): Promise<ConnectorExportInterface>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    exportConnectors(): Promise<ConnectorExportInterface>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    importConnector(
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        connectorId: string,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        importData: ConnectorExportInterface,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        options?: ConnectorImportOptions,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    ): Promise<ConnectorSkeleton>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    importConnectors(
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        importData: ConnectorExportInterface,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        options?: ConnectorImportOptions,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    ): Promise<ConnectorSkeleton[]>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    importFirstConnector(
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        importData: ConnectorExportInterface,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        options?: ConnectorImportOptions,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    ): Promise<ConnectorSkeleton>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    readConnector(connectorId: string): Promise<ConnectorSkeleton>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    readConnectors(): Promise<ConnectorSkeleton[]>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    updateConnector(
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        connectorId: string,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        connectorData: ConnectorSkeleton,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    ): Promise<ConnectorSkeleton>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                }
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Index

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Properties

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                CONNECTOR_TYPE +Connector | Frodo Library - v4.0.0-11
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Frodo Library - v4.0.0-11
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Type Alias Connector

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  type Connector = {
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      CONNECTOR_TYPE: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      createConnector(
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          connectorId: string,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          connectorData: ConnectorSkeleton,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      ): Promise<ConnectorSkeleton>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      createConnectorExportTemplate(): ConnectorExportInterface;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      deleteConnector(
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          connectorId: string,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          deep?: boolean,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      ): Promise<ConnectorSkeleton>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      deleteConnectors(deep?: boolean): Promise<ConnectorSkeleton[]>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      exportConnector(
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          connectorId: string,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          options?: ConnectorExportOptions,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      ): Promise<ConnectorExportInterface>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      exportConnectors(): Promise<ConnectorExportInterface>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      importConnector(
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          connectorId: string,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          importData: ConnectorExportInterface,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          options?: ConnectorImportOptions,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      ): Promise<ConnectorSkeleton>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      importConnectors(
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          importData: ConnectorExportInterface,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          options?: ConnectorImportOptions,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      ): Promise<ConnectorSkeleton[]>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      importFirstConnector(
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          importData: ConnectorExportInterface,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          options?: ConnectorImportOptions,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      ): Promise<ConnectorSkeleton>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      readConnector(connectorId: string): Promise<ConnectorSkeleton>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      readConnectors(): Promise<ConnectorSkeleton[]>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      updateConnector(
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          connectorId: string,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          connectorData: ConnectorSkeleton,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      ): Promise<ConnectorSkeleton>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  }
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Index

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Properties

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  CONNECTOR_TYPE: string

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Connector type key used to build the IDM id: '/'

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Methods

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Methods

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • Delete connector

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • connectorId: string

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      id/name of the connector without the type prefix

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • Optionaldeep: boolean

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      deep delete (remove dependencies)

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Returns Promise<ConnectorSkeleton>

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    a promise that resolves an connector object

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  diff --git a/docs/types/Reference.ConnectorSkeleton.html b/docs/types/Reference.ConnectorSkeleton.html index 2e41201a6..055275bf2 100644 --- a/docs/types/Reference.ConnectorSkeleton.html +++ b/docs/types/Reference.ConnectorSkeleton.html @@ -1 +1 @@ -ConnectorSkeleton | Frodo Library - v4.0.0-10
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Frodo Library - v4.0.0-10
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Type Alias ConnectorSkeleton

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    ConnectorSkeleton: IdObjectSkeletonInterface & {
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        configurationProperties: any;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        connectorRef: {
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            bundleName: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            bundleVersion: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            connectorHostRef: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            connectorName: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            displayName: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            systemType: "provisioner.openicf";
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        };
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        enabled: boolean;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        objectTypes: Record<string, ObjectTypeSkeleton>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    }
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    +ConnectorSkeleton | Frodo Library - v4.0.0-11
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Frodo Library - v4.0.0-11
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Type Alias ConnectorSkeleton

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      ConnectorSkeleton: IdObjectSkeletonInterface & {
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          configurationProperties: any;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          connectorRef: {
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              bundleName: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              bundleVersion: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              connectorHostRef: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              connectorName: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              displayName: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              systemType: "provisioner.openicf";
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          };
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          enabled: boolean;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          objectTypes: Record<string, ObjectTypeSkeleton>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      }
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      diff --git a/docs/types/Reference.Constants.html b/docs/types/Reference.Constants.html index 3ca31a4cd..9f0758c05 100644 --- a/docs/types/Reference.Constants.html +++ b/docs/types/Reference.Constants.html @@ -1,4 +1,4 @@ -Constants | Frodo Library - v4.0.0-10
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Frodo Library - v4.0.0-10
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Type Alias Constants

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        type Constants = {
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            CLASSIC_DEPLOYMENT_TYPE_KEY: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            CLOUD_DEPLOYMENT_TYPE_KEY: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            DEFAULT_REALM_KEY: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            DEPLOYMENT_TYPE_REALM_MAP: {
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                classic: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                cloud: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                forgeops: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            };
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            DEPLOYMENT_TYPES: string[];
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            FORGEOPS_DEPLOYMENT_TYPE_KEY: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            FRODO_CONNECTION_PROFILES_PATH_KEY: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            FRODO_MASTER_KEY_KEY: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            FRODO_MASTER_KEY_PATH_KEY: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            FRODO_METADATA_ID: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            RETRY_EVERYTHING_KEY: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            RETRY_NETWORK_KEY: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            RETRY_NOTHING_KEY: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            RETRY_STRATEGIES: string[];
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        }
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Index

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Properties

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        CLASSIC_DEPLOYMENT_TYPE_KEY +Constants | Frodo Library - v4.0.0-11
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Frodo Library - v4.0.0-11
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Type Alias Constants

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          type Constants = {
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              CLASSIC_DEPLOYMENT_TYPE_KEY: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              CLOUD_DEPLOYMENT_TYPE_KEY: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              DEFAULT_REALM_KEY: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              DEPLOYMENT_TYPE_REALM_MAP: {
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  classic: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  cloud: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  forgeops: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              };
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              DEPLOYMENT_TYPES: string[];
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              FORGEOPS_DEPLOYMENT_TYPE_KEY: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              FRODO_CONNECTION_PROFILES_PATH_KEY: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              FRODO_MASTER_KEY_KEY: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              FRODO_MASTER_KEY_PATH_KEY: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              FRODO_METADATA_ID: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              RETRY_EVERYTHING_KEY: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              RETRY_NETWORK_KEY: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              RETRY_NOTHING_KEY: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              RETRY_STRATEGIES: string[];
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          }
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Index

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Properties

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          CLASSIC_DEPLOYMENT_TYPE_KEY: string
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          CLOUD_DEPLOYMENT_TYPE_KEY: string
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          DEFAULT_REALM_KEY: string
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          DEPLOYMENT_TYPE_REALM_MAP: { classic: string; cloud: string; forgeops: string }
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          DEPLOYMENT_TYPES: string[]
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          FORGEOPS_DEPLOYMENT_TYPE_KEY: string
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          FRODO_CONNECTION_PROFILES_PATH_KEY: string
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          FRODO_MASTER_KEY_KEY: string
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          FRODO_MASTER_KEY_PATH_KEY: string
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          FRODO_METADATA_ID: string
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          RETRY_EVERYTHING_KEY: string
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          RETRY_NETWORK_KEY: string
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          RETRY_NOTHING_KEY: string
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          RETRY_STRATEGIES: string[]
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Properties

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          CLASSIC_DEPLOYMENT_TYPE_KEY: string
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          CLOUD_DEPLOYMENT_TYPE_KEY: string
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          DEFAULT_REALM_KEY: string
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          DEPLOYMENT_TYPE_REALM_MAP: { classic: string; cloud: string; forgeops: string }
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          DEPLOYMENT_TYPES: string[]
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          FORGEOPS_DEPLOYMENT_TYPE_KEY: string
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          FRODO_CONNECTION_PROFILES_PATH_KEY: string
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          FRODO_MASTER_KEY_KEY: string
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          FRODO_MASTER_KEY_PATH_KEY: string
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          FRODO_METADATA_ID: string
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          RETRY_EVERYTHING_KEY: string
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          RETRY_NETWORK_KEY: string
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          RETRY_NOTHING_KEY: string
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          RETRY_STRATEGIES: string[]
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          diff --git a/docs/types/Reference.DeleteJourneyStatus.html b/docs/types/Reference.DeleteJourneyStatus.html index 69545a55b..44f4b8fff 100644 --- a/docs/types/Reference.DeleteJourneyStatus.html +++ b/docs/types/Reference.DeleteJourneyStatus.html @@ -1,3 +1,3 @@ -DeleteJourneyStatus | Frodo Library - v4.0.0-10
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Frodo Library - v4.0.0-10
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Type Alias DeleteJourneyStatus

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            type DeleteJourneyStatus = {
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                nodes: { status?: string };
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                status: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            }
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Index

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Properties

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            nodes +DeleteJourneyStatus | Frodo Library - v4.0.0-11
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Frodo Library - v4.0.0-11
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Type Alias DeleteJourneyStatus

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              type DeleteJourneyStatus = {
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  nodes: { status?: string };
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  status: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              }
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Index

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Properties

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Properties

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              nodes: { status?: string }
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              status: string
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Properties

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              nodes: { status?: string }
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              status: string
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              diff --git a/docs/types/Reference.DeleteJourneysStatus.html b/docs/types/Reference.DeleteJourneysStatus.html index 84b7f433d..10fdfdf24 100644 --- a/docs/types/Reference.DeleteJourneysStatus.html +++ b/docs/types/Reference.DeleteJourneysStatus.html @@ -1 +1 @@ -DeleteJourneysStatus | Frodo Library - v4.0.0-10
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Frodo Library - v4.0.0-10
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Type Alias DeleteJourneysStatus

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                DeleteJourneysStatus: { [k: string]: DeleteJourneyStatus }

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Type Declaration

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                +DeleteJourneysStatus | Frodo Library - v4.0.0-11
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Frodo Library - v4.0.0-11
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Type Alias DeleteJourneysStatus

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  DeleteJourneysStatus: { [k: string]: DeleteJourneyStatus }

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Type Declaration

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  diff --git a/docs/types/Reference.EmailTemplate.html b/docs/types/Reference.EmailTemplate.html index 2ba7666ee..24d3ad058 100644 --- a/docs/types/Reference.EmailTemplate.html +++ b/docs/types/Reference.EmailTemplate.html @@ -1,4 +1,4 @@ -EmailTemplate | Frodo Library - v4.0.0-10
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Frodo Library - v4.0.0-10
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Type Alias EmailTemplate

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    type EmailTemplate = {
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        EMAIL_TEMPLATE_TYPE: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        createEmailTemplate(
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            templateId: string,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            templateData: EmailTemplateSkeleton,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        ): Promise<EmailTemplateSkeleton>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        createEmailTemplateExportTemplate(): EmailTemplateExportInterface;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        deleteEmailTemplate(templateId: string): Promise<EmailTemplateSkeleton>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        deleteEmailTemplates(): Promise<EmailTemplateSkeleton[]>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        exportEmailTemplates(
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            includeDefault?: boolean,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        ): Promise<EmailTemplateExportInterface>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        getEmailTemplate(templateId: string): Promise<EmailTemplateSkeleton>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        getEmailTemplates(): Promise<EmailTemplateSkeleton[]>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        importEmailTemplates(
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            importData: EmailTemplateExportInterface,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        ): Promise<EmailTemplateSkeleton[]>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        putEmailTemplate(
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            templateId: string,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            templateData: EmailTemplateSkeleton,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        ): Promise<EmailTemplateSkeleton>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        readEmailTemplate(templateId: string): Promise<EmailTemplateSkeleton>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        readEmailTemplates(
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            includeDefault?: boolean,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        ): Promise<EmailTemplateSkeleton[]>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        updateEmailTemplate(
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            templateId: string,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            templateData: EmailTemplateSkeleton,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        ): Promise<EmailTemplateSkeleton>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    }
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Index

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Properties

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    EMAIL_TEMPLATE_TYPE +EmailTemplate | Frodo Library - v4.0.0-11
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Frodo Library - v4.0.0-11
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Type Alias EmailTemplate

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      type EmailTemplate = {
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          EMAIL_TEMPLATE_TYPE: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          createEmailTemplate(
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              templateId: string,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              templateData: EmailTemplateSkeleton,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          ): Promise<EmailTemplateSkeleton>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          createEmailTemplateExportTemplate(): EmailTemplateExportInterface;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          deleteEmailTemplate(templateId: string): Promise<EmailTemplateSkeleton>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          deleteEmailTemplates(): Promise<EmailTemplateSkeleton[]>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          exportEmailTemplates(
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              includeDefault?: boolean,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          ): Promise<EmailTemplateExportInterface>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          getEmailTemplate(templateId: string): Promise<EmailTemplateSkeleton>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          getEmailTemplates(): Promise<EmailTemplateSkeleton[]>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          importEmailTemplates(
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              importData: EmailTemplateExportInterface,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          ): Promise<EmailTemplateSkeleton[]>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          putEmailTemplate(
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              templateId: string,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              templateData: EmailTemplateSkeleton,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          ): Promise<EmailTemplateSkeleton>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          readEmailTemplate(templateId: string): Promise<EmailTemplateSkeleton>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          readEmailTemplates(
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              includeDefault?: boolean,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          ): Promise<EmailTemplateSkeleton[]>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          updateEmailTemplate(
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              templateId: string,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              templateData: EmailTemplateSkeleton,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          ): Promise<EmailTemplateSkeleton>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      }
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Index

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Properties

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      EMAIL_TEMPLATE_TYPE: string

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Email template type key used to build the IDM id: 'emailTemplate/'

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Methods

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Methods

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • Export all email templates. The response can be saved to file as is.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • OptionalincludeDefault: boolean

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Include default email templates if true, false to exclude them. Default: false

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Returns Promise<EmailTemplateExportInterface>

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Promise resolving to a EmailTemplateExportInterface object.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • Get all email templates

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • OptionalincludeDefault: boolean

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Include default email templates if true, false to exclude them. Default: false

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Returns Promise<EmailTemplateSkeleton[]>

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        a promise that resolves to an array of email template objects

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Deprecated

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Deprecated

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • Put email template

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • templateId: string

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          id/name of the email template without the type prefix

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • templateData: EmailTemplateSkeleton

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          email template object

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Returns Promise<EmailTemplateSkeleton>

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        a promise that resolves to an email template object

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        @@ -60,4 +60,4 @@
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        updateEmailTemplate(templateId: string, templateData: EmailTemplateSkeleton): Promise<EmailTemplateSkeleton>
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        createEmailTemplate(templateId: string, templateData: EmailTemplateSkeleton): Promise<EmailTemplateSkeleton>
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      diff --git a/docs/types/Reference.EmailTemplateSkeleton.html b/docs/types/Reference.EmailTemplateSkeleton.html index 1275cf0cd..c14da8203 100644 --- a/docs/types/Reference.EmailTemplateSkeleton.html +++ b/docs/types/Reference.EmailTemplateSkeleton.html @@ -1 +1 @@ -EmailTemplateSkeleton | Frodo Library - v4.0.0-10
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Frodo Library - v4.0.0-10
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Type Alias EmailTemplateSkeleton

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        EmailTemplateSkeleton: IdObjectSkeletonInterface & {
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            defaultLocale?: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            displayName?: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            enabled?: boolean;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            from: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            html?: Record<string, string>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            message?: Record<string, string>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            subject: Record<string, string>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        }
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        +EmailTemplateSkeleton | Frodo Library - v4.0.0-11
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Frodo Library - v4.0.0-11
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Type Alias EmailTemplateSkeleton

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          EmailTemplateSkeleton: IdObjectSkeletonInterface & {
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              defaultLocale?: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              displayName?: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              enabled?: boolean;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              from: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              html?: Record<string, string>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              message?: Record<string, string>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              subject: Record<string, string>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          }
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          diff --git a/docs/types/Reference.ExportImport.html b/docs/types/Reference.ExportImport.html index f4db3ddd6..63ad15fa0 100644 --- a/docs/types/Reference.ExportImport.html +++ b/docs/types/Reference.ExportImport.html @@ -1,4 +1,4 @@ -ExportImport | Frodo Library - v4.0.0-10
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Frodo Library - v4.0.0-10
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Type Alias ExportImport

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            type ExportImport = {
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                appendTextToFile(data: string, filename: string): void;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                convertBase64TextToArray(b64text: string): any[];
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                convertBase64UrlTextToArray(b64UTF8Text: string): any[];
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                convertTextArrayToBase64(textArray: string[]): string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                convertTextArrayToBase64Url(textArray: string[]): any;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                findFilesByName(fileName: string, fast?: boolean, path?: string): string[];
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                getFilePath(fileName: string, mkdirs?: boolean): string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                getMetadata(): ExportMetaData;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                getRealmString(): string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                getTypedFilename(name: string, type: string, suffix?: string): string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                getWorkingDirectory(mkdirs?: boolean): string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                isValidUrl(urlString: string): boolean;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                parseUrl(href: string): any;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                readFiles(directory: string): Promise<{ content: string; path: string }[]>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                saveJsonToFile(
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    data: object,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    filename: string,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    includeMeta?: boolean,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    keepRev?: boolean,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                ): boolean;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                saveTextToFile(data: string, filename: string): boolean;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                saveToFile(
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    type: string,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    data: object,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    identifier: string,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    filename: string,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    includeMeta?: boolean,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                ): void;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                substituteEnvParams(input: string, reader: Reader): string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                titleCase(input: string): string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                unSubstituteEnvParams(input: string, reader: Reader): string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                validateImport(metadata: any): boolean;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            }
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Index

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Methods

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            appendTextToFile +ExportImport | Frodo Library - v4.0.0-11
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Frodo Library - v4.0.0-11
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Type Alias ExportImport

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              type ExportImport = {
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  appendTextToFile(data: string, filename: string): void;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  convertBase64TextToArray(b64text: string): any[];
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  convertBase64UrlTextToArray(b64UTF8Text: string): any[];
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  convertTextArrayToBase64(textArray: string[]): string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  convertTextArrayToBase64Url(textArray: string[]): any;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  findFilesByName(fileName: string, fast?: boolean, path?: string): string[];
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  getFilePath(fileName: string, mkdirs?: boolean): string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  getMetadata(): ExportMetaData;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  getRealmString(): string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  getTypedFilename(name: string, type: string, suffix?: string): string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  getWorkingDirectory(mkdirs?: boolean): string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  isValidUrl(urlString: string): boolean;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  parseUrl(href: string): any;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  readFiles(directory: string): Promise<{ content: string; path: string }[]>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  saveJsonToFile(
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      data: object,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      filename: string,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      includeMeta?: boolean,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      keepRev?: boolean,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  ): boolean;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  saveTextToFile(data: string, filename: string): boolean;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  saveToFile(
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      type: string,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      data: object,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      identifier: string,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      filename: string,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      includeMeta?: boolean,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  ): void;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  substituteEnvParams(input: string, reader: Reader): string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  titleCase(input: string): string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  unSubstituteEnvParams(input: string, reader: Reader): string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  validateImport(metadata: any): boolean;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              }
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Index

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Methods

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • Append text data to file

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • data: string

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  text data

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • filename: string

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  file name

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Returns void

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • Find files by name

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Returns void

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • Find files by name

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • fileName: string

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  file name to search for

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • Optionalfast: boolean

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  return first result and stop search

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • Optionalpath: string

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  path to directory where to start the search

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Returns string[]

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                array of found file paths relative to starting directory

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • fileName: string
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • Optionalmkdirs: boolean

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Returns string

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • name: string
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • type: string
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • Optionalsuffix: string

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Returns string

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • fileName: string
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • Optionalmkdirs: boolean

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Returns string

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • name: string
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • type: string
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • Optionalsuffix: string

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Returns string

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • Check if a string is a valid URL

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • urlString: string

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  input string to be evaluated

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Returns boolean

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                true if a valid URL, false otherwise

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • find all (nested) files in a directory

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • find all (nested) files in a directory

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • directory: string

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  directory to search

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Returns Promise<{ content: string; path: string }[]>

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                list of files

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • Save JSON object to file

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • Save JSON object to file

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • data: object

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  data object

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • filename: string

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  file name

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • OptionalincludeMeta: boolean

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  true to include metadata, false otherwise. Default: true

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • OptionalkeepRev: boolean

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  keep the _rev key from objects. Default: false

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Returns boolean

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                true if successful, false otherwise

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • Save text data to file

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • data: string

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  text data

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • filename: string

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  file name

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Returns boolean

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                true if successful, false otherwise

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • type: string
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • data: object
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • identifier: string
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • filename: string
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • OptionalincludeMeta: boolean

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Returns void

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • input: string
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • reader: Reader

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Returns string

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • input: string
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • reader: Reader

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Returns string

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              diff --git a/docs/types/Reference.FRUtils.html b/docs/types/Reference.FRUtils.html index 40546c218..35d62ae5f 100644 --- a/docs/types/Reference.FRUtils.html +++ b/docs/types/Reference.FRUtils.html @@ -1,4 +1,4 @@ -FRUtils | Frodo Library - v4.0.0-10
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Frodo Library - v4.0.0-10
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Type Alias FRUtils

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                type FRUtils = {
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    applyNameCollisionPolicy(name: string): string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    getCurrentRealmManagedUser(): string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    getCurrentRealmName(): string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    getCurrentRealmPath(): string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    getHostBaseUrl(url: string): string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    getHostUrl(url: string): string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    getIdmBaseUrl(): string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    getRealmName(realm: string): string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    getRealmPath(realm: string): string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    getRealmsForExport(): Promise<string[]>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    getRealmUsingExportFormat(realm: string): string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    getRealmUsingExportFormat(realm: string): string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                }
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Index

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Methods

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                applyNameCollisionPolicy +FRUtils | Frodo Library - v4.0.0-11
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Frodo Library - v4.0.0-11
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Type Alias FRUtils

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  type FRUtils = {
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      applyNameCollisionPolicy(name: string): string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      getCurrentRealmManagedUser(): string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      getCurrentRealmName(): string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      getCurrentRealmPath(): string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      getHostBaseUrl(url: string): string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      getHostUrl(url: string): string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      getIdmBaseUrl(): string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      getRealmName(realm: string): string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      getRealmPath(realm: string): string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      getRealmsForExport(): Promise<string[]>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      getRealmUsingExportFormat(realm: string): string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      getRealmUsingExportFormat(realm: string): string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  }
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Index

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Methods

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • Get host URL without path and query params

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Methods

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • Get host URL without path and query params

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • url: string

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      tenant URL with path and query params

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Returns string

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    AM host URL without path and query params

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • Get IDM base URL

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Returns string

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    IDM host URL without path and query params

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • Gets the list of realms to be used for exports in special format. +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • Gets the list of realms to be used for exports in special format. e.g. if the realm is normally '/first/second', then it will return 'root-first-second'.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Returns Promise<string[]>

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • realm: string

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Returns string

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • Helper that gets the normal realm name from the realm export format. +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Returns Promise<string[]>

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • realm: string

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Returns string

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • Helper that gets the normal realm name from the realm export format. It reverses the format generated by getRealmsForExport. e.g. if the realm is 'root-first-second', then it will return '/first/second'.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • realm: string

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      realm in export format

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Returns string

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Deprecated

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • Get host URL without path and query params

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Returns string

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Deprecated

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • Get host URL without path and query params

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • url: string

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      tenant URL with path and query params

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Returns string

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    AM host URL without path and query params

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    since v2.1.2 use getHostUrl instead

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    getHostUrl(url: string): string
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                     
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  diff --git a/docs/types/Reference.Feature.html b/docs/types/Reference.Feature.html index 42fc9e7f6..62f14ea97 100644 --- a/docs/types/Reference.Feature.html +++ b/docs/types/Reference.Feature.html @@ -1,8 +1,8 @@ -Feature | Frodo Library - v4.0.0-10
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Frodo Library - v4.0.0-10
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Type Alias Feature

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    type Feature = {
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        hasFeature(featureId: string): Promise<boolean>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        readFeatures(): Promise<FeatureInterface[]>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    }
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Index

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Methods

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    hasFeature +Feature | Frodo Library - v4.0.0-11
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Frodo Library - v4.0.0-11
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Type Alias Feature

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      type Feature = {
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          hasFeature(featureId: string): Promise<boolean>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          readFeatures(): Promise<FeatureInterface[]>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      }
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Index

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Methods

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • Check if feature is available

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • featureId: string

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          feature id (e.g. 'service-accounts')

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Returns Promise<boolean>

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        a promise that resolves to true if the feature is available and to false otherwise

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      diff --git a/docs/types/Reference.Frodo.html b/docs/types/Reference.Frodo.html index 2112b7f9a..117822593 100644 --- a/docs/types/Reference.Frodo.html +++ b/docs/types/Reference.Frodo.html @@ -1,5 +1,5 @@ -Frodo | Frodo Library - v4.0.0-10
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Frodo Library - v4.0.0-10
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Type Alias Frodo

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Frodo Library

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        type Frodo = {
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            admin: Admin;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            agent: Agent;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            am: { config: AmConfig };
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            app: Application;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            authn: { journey: Journey; node: Node; settings: AuthenticationSettings };
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            authz: { policy: Policy; policySet: PolicySet; resourceType: ResourceType };
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            cache: TokenCache;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            cloud: EsvCount & {
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                adminFed: AdminFederation;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                env: EnvContentSecurityPolicy & EnvCookieDomains & EnvCustomDomains & EnvFederationEnforcement & EnvRelease & EnvServiceAccountScopes & EnvSSOCookieConfig & {
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    cert: EnvCertificate;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    csr: EnvCSR;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    promotion: EnvPromotion;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                };
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                esvCount: EsvCount;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                feature: Feature;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                log: Log;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                secret: Secret;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                serviceAccount: ServiceAccount;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                startup: Startup;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                variable: Variable;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            };
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            config: Config;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            conn: ConnectionProfile;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            email: { template: EmailTemplate };
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            factory: ApiFactory;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            idm: {
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                config: IdmConfig;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                connector: Connector;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                crypto: IdmCrypto;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                managed: ManagedObject;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                mapping: Mapping;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                organization: Organization;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                recon: Recon;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                script: IdmScript;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                system: IdmSystem;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            };
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            info: Info;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            login: Authenticate;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            oauth2oidc: {
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                client: OAuth2Client;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                endpoint: OAuth2Oidc;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                external: Idp;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                issuer: OAuth2TrustedJwtIssuer;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                provider: OAuth2Provider;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            };
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            rawConfig: RawConfig;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            realm: Realm;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            role: InternalRole;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            saml2: { circlesOfTrust: CirclesOfTrust; entityProvider: Saml2 };
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            script: Script;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            scriptType: ScriptType;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            secretStore: SecretStore;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            server: Server;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            service: Service;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            session: Session;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            site: Site;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            state: State;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            theme: Theme;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            user: User;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            utils: FRUtils & ScriptValidation & ExportImport & Base64 & {
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                constants: Constants;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                crypto: FrodoCrypto;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                jose: Jose;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                json: Json;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                version: Version;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            };
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            createInstance(config: StateInterface): Frodo;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            createInstanceWithAdminAccount(
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                host: string,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                username: string,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                password: string,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                realm?: string,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                deploymentType?: string,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                allowInsecureConnection?: boolean,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                debug?: boolean,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                curlirize?: boolean,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            ): Frodo;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            createInstanceWithAmsterAccount(
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                host: string,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                amsterPrivateKey: string,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                authenticationService?: string,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                realm?: string,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                deploymentType?: string,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                allowInsecureConnection?: boolean,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                debug?: boolean,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                curlirize?: boolean,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            ): Frodo;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            createInstanceWithServiceAccount(
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                host: string,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                serviceAccountId: string,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                serviceAccountJwkStr: string,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                realm?: string,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                deploymentType?: string,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                allowInsecureConnection?: boolean,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                debug?: boolean,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                curlirize?: boolean,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            ): Frodo;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        }
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Index

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Properties

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        admin +Frodo | Frodo Library - v4.0.0-11
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Frodo Library - v4.0.0-11
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Type Alias Frodo

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Frodo Library

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          type Frodo = {
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              admin: Admin;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              agent: Agent;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              am: { config: AmConfig };
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              app: Application;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              authn: { journey: Journey; node: Node; settings: AuthenticationSettings };
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              authz: { policy: Policy; policySet: PolicySet; resourceType: ResourceType };
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              cache: TokenCache;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              cloud: EsvCount & {
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  adminFed: AdminFederation;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  env: EnvContentSecurityPolicy & EnvCookieDomains & EnvCustomDomains & EnvFederationEnforcement & EnvRelease & EnvServiceAccountScopes & EnvSSOCookieConfig & {
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      cert: EnvCertificate;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      csr: EnvCSR;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      promotion: EnvPromotion;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  };
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  esvCount: EsvCount;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  feature: Feature;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  log: Log;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  secret: Secret;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  serviceAccount: ServiceAccount;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  startup: Startup;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  variable: Variable;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              };
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              config: Config;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              conn: ConnectionProfile;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              email: { template: EmailTemplate };
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              factory: ApiFactory;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              idm: {
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  config: IdmConfig;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  connector: Connector;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  crypto: IdmCrypto;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  managed: ManagedObject;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  mapping: Mapping;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  organization: Organization;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  recon: Recon;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  script: IdmScript;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  system: IdmSystem;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              };
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              info: Info;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              login: Authenticate;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              oauth2oidc: {
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  client: OAuth2Client;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  endpoint: OAuth2Oidc;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  external: Idp;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  issuer: OAuth2TrustedJwtIssuer;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  provider: OAuth2Provider;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              };
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              rawConfig: RawConfig;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              realm: Realm;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              role: InternalRole;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              saml2: { circlesOfTrust: CirclesOfTrust; entityProvider: Saml2 };
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              script: Script;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              scriptType: ScriptType;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              secretStore: SecretStore;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              server: Server;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              service: Service;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              session: Session;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              site: Site;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              state: State;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              theme: Theme;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              user: User;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              utils: FRUtils & ScriptValidation & ExportImport & Base64 & {
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  constants: Constants;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  crypto: FrodoCrypto;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  jose: Jose;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  json: Json;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  version: Version;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              };
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              createInstance(config: StateInterface): Frodo;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              createInstanceWithAdminAccount(
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  host: string,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  username: string,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  password: string,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  realm?: string,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  deploymentType?: string,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  allowInsecureConnection?: boolean,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  debug?: boolean,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  curlirize?: boolean,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              ): Frodo;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              createInstanceWithAmsterAccount(
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  host: string,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  amsterPrivateKey: string,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  authenticationService?: string,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  realm?: string,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  deploymentType?: string,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  allowInsecureConnection?: boolean,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  debug?: boolean,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  curlirize?: boolean,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              ): Frodo;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              createInstanceWithServiceAccount(
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  host: string,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  serviceAccountId: string,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  serviceAccountJwkStr: string,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  realm?: string,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  deploymentType?: string,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  allowInsecureConnection?: boolean,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  debug?: boolean,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  curlirize?: boolean,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              ): Frodo;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          }
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Index

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Properties

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          admin: Admin
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          agent: Agent
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          am: { config: AmConfig }
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          authn: { journey: Journey; node: Node; settings: AuthenticationSettings }
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          authz: { policy: Policy; policySet: PolicySet; resourceType: ResourceType }
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          cache: TokenCache
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          cloud: EsvCount & {
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              adminFed: AdminFederation;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              env: EnvContentSecurityPolicy & EnvCookieDomains & EnvCustomDomains & EnvFederationEnforcement & EnvRelease & EnvServiceAccountScopes & EnvSSOCookieConfig & {
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  cert: EnvCertificate;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  csr: EnvCSR;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  promotion: EnvPromotion;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              };
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              esvCount: EsvCount;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              feature: Feature;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              log: Log;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              secret: Secret;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              serviceAccount: ServiceAccount;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              startup: Startup;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              variable: Variable;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          }

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Type Declaration

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          config: Config
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          email: { template: EmailTemplate }
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          factory: ApiFactory
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          idm: {
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              config: IdmConfig;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              connector: Connector;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              crypto: IdmCrypto;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              managed: ManagedObject;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              mapping: Mapping;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              organization: Organization;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              recon: Recon;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              script: IdmScript;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              system: IdmSystem;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          }
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          info: Info
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          oauth2oidc: {
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              client: OAuth2Client;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              endpoint: OAuth2Oidc;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              external: Idp;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              issuer: OAuth2TrustedJwtIssuer;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              provider: OAuth2Provider;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          }
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          rawConfig: RawConfig
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          realm: Realm
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          saml2: { circlesOfTrust: CirclesOfTrust; entityProvider: Saml2 }
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          script: Script
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          scriptType: ScriptType
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          secretStore: SecretStore
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          server: Server
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          service: Service
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          session: Session
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          site: Site
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          state: State
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          theme: Theme
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          user: User
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          utils: FRUtils & ScriptValidation & ExportImport & Base64 & {
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              constants: Constants;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              crypto: FrodoCrypto;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              jose: Jose;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              json: Json;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              version: Version;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          }

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Methods

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Properties

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          admin: Admin
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          agent: Agent
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          am: { config: AmConfig }
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          authn: { journey: Journey; node: Node; settings: AuthenticationSettings }
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          authz: { policy: Policy; policySet: PolicySet; resourceType: ResourceType }
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          cache: TokenCache
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          cloud: EsvCount & {
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              adminFed: AdminFederation;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              env: EnvContentSecurityPolicy & EnvCookieDomains & EnvCustomDomains & EnvFederationEnforcement & EnvRelease & EnvServiceAccountScopes & EnvSSOCookieConfig & {
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  cert: EnvCertificate;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  csr: EnvCSR;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  promotion: EnvPromotion;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              };
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              esvCount: EsvCount;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              feature: Feature;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              log: Log;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              secret: Secret;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              serviceAccount: ServiceAccount;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              startup: Startup;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              variable: Variable;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          }

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Type Declaration

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          config: Config
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          email: { template: EmailTemplate }
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          factory: ApiFactory
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          idm: {
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              config: IdmConfig;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              connector: Connector;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              crypto: IdmCrypto;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              managed: ManagedObject;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              mapping: Mapping;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              organization: Organization;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              recon: Recon;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              script: IdmScript;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              system: IdmSystem;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          }
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          info: Info
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          oauth2oidc: {
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              client: OAuth2Client;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              endpoint: OAuth2Oidc;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              external: Idp;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              issuer: OAuth2TrustedJwtIssuer;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              provider: OAuth2Provider;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          }
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          rawConfig: RawConfig
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          realm: Realm
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          saml2: { circlesOfTrust: CirclesOfTrust; entityProvider: Saml2 }
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          script: Script
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          scriptType: ScriptType
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          secretStore: SecretStore
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          server: Server
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          service: Service
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          session: Session
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          site: Site
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          state: State
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          theme: Theme
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          user: User
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          utils: FRUtils & ScriptValidation & ExportImport & Base64 & {
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              constants: Constants;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              crypto: FrodoCrypto;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              jose: Jose;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              json: Json;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              version: Version;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          }

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Methods

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • Factory helper to create a frodo instance ready for logging in with an admin user account

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • Factory helper to create a frodo instance ready for logging in with an admin user account

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • host: string
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • username: string

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              admin account username

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • password: string

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              admin account password

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              @@ -48,7 +48,7 @@
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • Optionaldebug: boolean

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              (optional) enable debug output

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • Optionalcurlirize: boolean

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              (optional) enable output of all library REST calls as curl commands

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Returns Frodo

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            frodo instance

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • Factory helper to create a frodo instance ready for logging in with Amster credentials

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • Factory helper to create a frodo instance ready for logging in with Amster credentials

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • host: string

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              host base URL, e.g. 'https://am.example.com:8443/am'

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • amsterPrivateKey: string

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              the pem encoded private key used to authenticate with Amster

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • OptionalauthenticationService: string

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              (optional) the authentication service used to authenticate with Amster (default: 'amsterService')

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              @@ -58,7 +58,7 @@
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • Optionaldebug: boolean

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              (optional) enable debug output

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • Optionalcurlirize: boolean

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              (optional) enable output of all library REST calls as curl commands

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Returns Frodo

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            frodo instance

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • Factory helper to create a frodo instance ready for logging in with a service account

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • Factory helper to create a frodo instance ready for logging in with a service account

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • host: string
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • serviceAccountId: string

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              service account uuid

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • serviceAccountJwkStr: string

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              service account JWK as stringified JSON

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              @@ -68,4 +68,4 @@
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • Optionaldebug: boolean

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              (optional) enable debug output

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • Optionalcurlirize: boolean

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              (optional) enable output of all library REST calls as curl commands

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Returns Frodo

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            frodo instance

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          diff --git a/docs/types/Reference.GatewayAgentType.html b/docs/types/Reference.GatewayAgentType.html index 15e20769b..ae94b3e4f 100644 --- a/docs/types/Reference.GatewayAgentType.html +++ b/docs/types/Reference.GatewayAgentType.html @@ -1 +1 @@ -GatewayAgentType | Frodo Library - v4.0.0-10
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Frodo Library - v4.0.0-10
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Type Alias GatewayAgentType

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            GatewayAgentType: "IdentityGatewayAgent"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            +GatewayAgentType | Frodo Library - v4.0.0-11
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Frodo Library - v4.0.0-11
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Type Alias GatewayAgentType

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              GatewayAgentType: "IdentityGatewayAgent"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              diff --git a/docs/types/Reference.IdmConfig.html b/docs/types/Reference.IdmConfig.html index b58d30ba8..87efcd957 100644 --- a/docs/types/Reference.IdmConfig.html +++ b/docs/types/Reference.IdmConfig.html @@ -1,4 +1,4 @@ -IdmConfig | Frodo Library - v4.0.0-10
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Frodo Library - v4.0.0-10
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Type Alias IdmConfig

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                type IdmConfig = {
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    createConfigEntity(
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        entityId: string,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        entityData: IdObjectSkeletonInterface,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        wait?: boolean,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    ): Promise<IdObjectSkeletonInterface>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    deleteConfigEntities(
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        resultCallback?: ResultCallback<IdObjectSkeletonInterface>,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    ): Promise<IdObjectSkeletonInterface[]>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    deleteConfigEntitiesByType(
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        type: string,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        resultCallback?: ResultCallback<IdObjectSkeletonInterface>,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    ): Promise<IdObjectSkeletonInterface[]>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    deleteConfigEntity(entityId: string): Promise<IdObjectSkeletonInterface>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    exportConfigEntities(
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        options?: ConfigEntityExportOptions,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        resultCallback?: ResultCallback<IdObjectSkeletonInterface>,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    ): Promise<ConfigEntityExportInterface>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    exportConfigEntity(
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        entityId: string,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        options?: ConfigEntityExportOptions,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    ): Promise<ConfigEntityExportInterface>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    getAllConfigEntities(): Promise<IdmConfigStub[]>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    getConfigEntitiesByType(type: string): Promise<IdObjectSkeletonInterface[]>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    getConfigEntity(entityId: string): Promise<IdObjectSkeletonInterface>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    getConfigEntityTypes(): Promise<string[]>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    importConfigEntities(
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        importData: ConfigEntityExportInterface,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        entityId?: string,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        options?: ConfigEntityImportOptions,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        resultCallback?: ResultCallback<IdObjectSkeletonInterface>,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    ): Promise<IdObjectSkeletonInterface[]>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    importSubConfigEntity(
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        entityId: string,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        updatedSubConfigEntity: IdObjectSkeletonInterface,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        options?: ConfigEntityImportOptions,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    ): Promise<IdObjectSkeletonInterface[]>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    putConfigEntity(
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        entityId: string,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        entityData: IdObjectSkeletonInterface,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    ): Promise<IdObjectSkeletonInterface>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    readConfigEntities(): Promise<IdObjectSkeletonInterface[]>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    readConfigEntitiesByType(
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        type: string,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        includeDefault?: boolean,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    ): Promise<IdObjectSkeletonInterface[]>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    readConfigEntity(entityId: string): Promise<IdObjectSkeletonInterface>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    readConfigEntityStubs(): Promise<IdmConfigStub[]>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    readConfigEntityTypes(): Promise<string[]>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    readSubConfigEntity(
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        entityId: string,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        name: string,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        options?: ConfigEntityExportOptions,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    ): Promise<NoIdObjectSkeletonInterface>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    testConnectorServers(): Promise<ConnectorServerStatusInterface[]>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    updateConfigEntity(
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        entityId: string,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        entityData: IdObjectSkeletonInterface,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        wait?: boolean,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    ): Promise<IdObjectSkeletonInterface>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                }
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Index

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Methods

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                createConfigEntity +IdmConfig | Frodo Library - v4.0.0-11
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Frodo Library - v4.0.0-11
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Type Alias IdmConfig

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  type IdmConfig = {
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      createConfigEntity(
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          entityId: string,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          entityData: IdObjectSkeletonInterface,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          wait?: boolean,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      ): Promise<IdObjectSkeletonInterface>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      deleteConfigEntities(
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          resultCallback?: ResultCallback<IdObjectSkeletonInterface>,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      ): Promise<IdObjectSkeletonInterface[]>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      deleteConfigEntitiesByType(
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          type: string,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          resultCallback?: ResultCallback<IdObjectSkeletonInterface>,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      ): Promise<IdObjectSkeletonInterface[]>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      deleteConfigEntity(entityId: string): Promise<IdObjectSkeletonInterface>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      exportConfigEntities(
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          options?: ConfigEntityExportOptions,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          resultCallback?: ResultCallback<IdObjectSkeletonInterface>,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      ): Promise<ConfigEntityExportInterface>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      exportConfigEntity(
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          entityId: string,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          options?: ConfigEntityExportOptions,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      ): Promise<ConfigEntityExportInterface>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      getAllConfigEntities(): Promise<IdmConfigStub[]>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      getConfigEntitiesByType(type: string): Promise<IdObjectSkeletonInterface[]>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      getConfigEntity(entityId: string): Promise<IdObjectSkeletonInterface>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      getConfigEntityTypes(): Promise<string[]>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      importConfigEntities(
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          importData: ConfigEntityExportInterface,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          entityId?: string,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          options?: ConfigEntityImportOptions,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          resultCallback?: ResultCallback<IdObjectSkeletonInterface>,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      ): Promise<IdObjectSkeletonInterface[]>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      importSubConfigEntity(
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          entityId: string,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          updatedSubConfigEntity: IdObjectSkeletonInterface,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          options?: ConfigEntityImportOptions,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      ): Promise<IdObjectSkeletonInterface[]>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      putConfigEntity(
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          entityId: string,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          entityData: IdObjectSkeletonInterface,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      ): Promise<IdObjectSkeletonInterface>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      readConfigEntities(): Promise<IdObjectSkeletonInterface[]>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      readConfigEntitiesByType(
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          type: string,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          includeDefault?: boolean,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      ): Promise<IdObjectSkeletonInterface[]>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      readConfigEntity(entityId: string): Promise<IdObjectSkeletonInterface>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      readConfigEntityStubs(): Promise<IdmConfigStub[]>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      readConfigEntityTypes(): Promise<string[]>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      readSubConfigEntity(
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          entityId: string,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          name: string,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          options?: ConfigEntityExportOptions,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      ): Promise<NoIdObjectSkeletonInterface>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      testConnectorServers(): Promise<ConnectorServerStatusInterface[]>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      updateConfigEntity(
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          entityId: string,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          entityData: IdObjectSkeletonInterface,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          wait?: boolean,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      ): Promise<IdObjectSkeletonInterface>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  }
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Index

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Methods

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • entityData: IdObjectSkeletonInterface

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  config entity data

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • Optionalwait: boolean

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  delay the response until an OSGi service event confirms the change has been consumed by the corresponding service or the request times out.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • Returns Promise<IdObjectSkeletonInterface>

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  promise resolving to a config entity

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • Read all config entities of a type

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • type: string

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      config entity type

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • OptionalincludeDefault: boolean

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Include default email templates if true, false to exclude them. Default: false

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Returns Promise<IdObjectSkeletonInterface[]>

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    promise resolving to an array of config entities of a type

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • Read available config entity types

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • Read available config entity types

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Returns Promise<string[]>

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    promise resolving to an array of config entity types

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Deprecated

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Deprecated

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  diff --git a/docs/types/Reference.IdmConfigStub.html b/docs/types/Reference.IdmConfigStub.html index 9f9040443..747ece53f 100644 --- a/docs/types/Reference.IdmConfigStub.html +++ b/docs/types/Reference.IdmConfigStub.html @@ -1 +1 @@ -IdmConfigStub | Frodo Library - v4.0.0-10
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Frodo Library - v4.0.0-10
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Type Alias IdmConfigStub

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    IdmConfigStub: IdObjectSkeletonInterface & {
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        _id: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        factoryPid: string | null;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        pid: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    }
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    +IdmConfigStub | Frodo Library - v4.0.0-11
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Frodo Library - v4.0.0-11
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Type Alias IdmConfigStub

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      IdmConfigStub: IdObjectSkeletonInterface & {
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          _id: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          factoryPid: string | null;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          pid: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      }
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      diff --git a/docs/types/Reference.IdmSystem.html b/docs/types/Reference.IdmSystem.html index e6ddb0ba3..d7c6dfdf8 100644 --- a/docs/types/Reference.IdmSystem.html +++ b/docs/types/Reference.IdmSystem.html @@ -1,4 +1,4 @@ -IdmSystem | Frodo Library - v4.0.0-10
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Frodo Library - v4.0.0-10
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Type Alias IdmSystem

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        type IdmSystem = {
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            authenticateSystemObject(
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                systemName: string,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                systemObjectType: string,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                username: string,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                password: string,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            ): Promise<IdObjectSkeletonInterface>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            createSystemObject(
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                systemName: string,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                systemObjectType: string,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                systemObjectData: IdObjectSkeletonInterface,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            ): Promise<IdObjectSkeletonInterface>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            deleteSystemObject(
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                systemName: string,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                systemObjectType: string,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                systemObjectId: string,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            ): Promise<IdObjectSkeletonInterface>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            queryAllSystemObjectIds(
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                systemName: string,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                systemObjectType: string,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                pageSize?: number,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                pageCookie?: string,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            ): Promise<PagedResult<IdObjectSkeletonInterface>>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            querySystemObjects(
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                systemName: string,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                systemObjectType: string,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                filter: string,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                fields?: string[],
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                pageSize?: number,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                pageCookie?: string,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            ): Promise<PagedResult<IdObjectSkeletonInterface>>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            readAvailableSystems(): Promise<SystemStatusInterface[]>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            readSystemObject(
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                systemName: string,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                systemObjectType: string,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                systemObjectId: string,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                fields?: string[],
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            ): Promise<IdObjectSkeletonInterface>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            readSystemSchema(
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                systemName: string,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            ): Promise<Record<string, ObjectTypeSkeleton>>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            readSystemStatus(systemName: string): Promise<SystemStatusInterface>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            runSystemScript(systemName: string, scriptName: string): Promise<any>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            testConnectorServers(): Promise<ConnectorServerStatusInterface[]>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            updateSystemObject(
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                systemName: string,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                systemObjectType: string,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                systemObjectId: string,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                systemObjectData: IdObjectSkeletonInterface,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                failIfExists?: boolean,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            ): Promise<IdObjectSkeletonInterface>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            updateSystemObjectProperties(
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                systemName: string,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                systemObjectType: string,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                systemObjectId: string,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                operations: SystemObjectPatchOperationInterface[],
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            ): Promise<IdObjectSkeletonInterface>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        }
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Index

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Methods

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        authenticateSystemObject +IdmSystem | Frodo Library - v4.0.0-11
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Frodo Library - v4.0.0-11
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Type Alias IdmSystem

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          type IdmSystem = {
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              authenticateSystemObject(
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  systemName: string,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  systemObjectType: string,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  username: string,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  password: string,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              ): Promise<IdObjectSkeletonInterface>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              createSystemObject(
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  systemName: string,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  systemObjectType: string,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  systemObjectData: IdObjectSkeletonInterface,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              ): Promise<IdObjectSkeletonInterface>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              deleteSystemObject(
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  systemName: string,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  systemObjectType: string,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  systemObjectId: string,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              ): Promise<IdObjectSkeletonInterface>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              queryAllSystemObjectIds(
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  systemName: string,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  systemObjectType: string,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  pageSize?: number,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  pageCookie?: string,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              ): Promise<PagedResult<IdObjectSkeletonInterface>>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              querySystemObjects(
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  systemName: string,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  systemObjectType: string,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  filter: string,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  fields?: string[],
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  pageSize?: number,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  pageCookie?: string,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              ): Promise<PagedResult<IdObjectSkeletonInterface>>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              readAvailableSystems(): Promise<SystemStatusInterface[]>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              readSystemObject(
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  systemName: string,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  systemObjectType: string,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  systemObjectId: string,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  fields?: string[],
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              ): Promise<IdObjectSkeletonInterface>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              readSystemSchema(
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  systemName: string,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              ): Promise<Record<string, ObjectTypeSkeleton>>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              readSystemStatus(systemName: string): Promise<SystemStatusInterface>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              runSystemScript(systemName: string, scriptName: string): Promise<any>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              testConnectorServers(): Promise<ConnectorServerStatusInterface[]>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              updateSystemObject(
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  systemName: string,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  systemObjectType: string,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  systemObjectId: string,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  systemObjectData: IdObjectSkeletonInterface,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  failIfExists?: boolean,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              ): Promise<IdObjectSkeletonInterface>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              updateSystemObjectProperties(
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  systemName: string,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  systemObjectType: string,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  systemObjectId: string,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  operations: SystemObjectPatchOperationInterface[],
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              ): Promise<IdObjectSkeletonInterface>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          }
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Index

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Methods

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • username: string

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          system object username

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • password: string

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          system object password

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • Returns Promise<IdObjectSkeletonInterface>

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          a promise resolving to an IdObjectSkeletonInterface object containing only the _id

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • Delete system object

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • systemName: string

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              name of system/connector

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • systemObjectType: string

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              type of system object

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • systemObjectId: string

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              id of system object

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Returns Promise<IdObjectSkeletonInterface>

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            a promise resolving to an IdObjectSkeletonInterface object

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • Query all system object ids

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • systemName: string

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              name of system/connector

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • systemObjectType: string

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              type of system object

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • OptionalpageSize: number

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              page size (default value: 1000)

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • OptionalpageCookie: string

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              paged results cookie

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Returns Promise<PagedResult<IdObjectSkeletonInterface>>

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            a promise resolving to an array of IdObjectSkeletonInterface objects

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • Query system objects using a search filter

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • Query system objects using a search filter

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • systemName: string

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              name of system/connector

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • systemObjectType: string

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              type of system object

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • filter: string

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              search filter

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              @@ -41,36 +41,36 @@
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • OptionalpageSize: number

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              page size (default value: 1000)

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • OptionalpageCookie: string

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              paged results cookie

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Returns Promise<PagedResult<IdObjectSkeletonInterface>>

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            a promise resolving to an array of IdObjectSkeletonInterface objects

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • Read system object

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • systemName: string

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              name of system/connector

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • systemObjectType: string

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              type of system object

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • systemObjectId: string

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              id of system object

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • Optionalfields: string[]

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              array of fields to return (default: ['*'])

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Returns Promise<IdObjectSkeletonInterface>

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            a promise resolving to an IdObjectSkeletonInterface object

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • Read system schema

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • systemName: string

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              name of system/connector

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Returns Promise<Record<string, ObjectTypeSkeleton>>

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            a promise resolving to a map of Record<string, ObjectTypeSkeleton>

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • Run system script

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • Run system script

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • systemName: string

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              name of system/connector

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • scriptName: string

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              name of script

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Returns Promise<any>

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            a promise resolving to a status object

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • Update or create system object

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • systemName: string

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              name of system/connector

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • systemObjectType: string

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              type of system object

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • systemObjectId: string

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              id of system object

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • systemObjectData: IdObjectSkeletonInterface

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              system object data

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • OptionalfailIfExists: boolean

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              fail if object exists (default value: false)

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Returns Promise<IdObjectSkeletonInterface>

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            a promise resolving to an IdObjectSkeletonInterface object

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          diff --git a/docs/types/Reference.Idp.html b/docs/types/Reference.Idp.html index cff2a6302..130101abc 100644 --- a/docs/types/Reference.Idp.html +++ b/docs/types/Reference.Idp.html @@ -1,4 +1,4 @@ -Idp | Frodo Library - v4.0.0-10
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Frodo Library - v4.0.0-10
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Type Alias Idp

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            type Idp = {
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                createSocialIdentityProvider(
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    providerType: string,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    providerId: string,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    providerData: SocialIdpSkeleton,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                ): Promise<SocialIdpSkeleton>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                deleteSocialIdentityProvider(
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    providerId: string,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                ): Promise<SocialIdpSkeleton>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                deleteSocialIdentityProviders(): Promise<SocialIdpSkeleton[]>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                deleteSocialProvider(providerId: string): Promise<SocialIdpSkeleton>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                exportSocialIdentityProvider(
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    providerId: string,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                ): Promise<SocialProviderExportInterface>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                exportSocialIdentityProviders(
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    options?: SocialIdentityProviderExportOptions,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                ): Promise<SocialProviderExportInterface>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                exportSocialProvider(
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    providerId: string,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                ): Promise<SocialProviderExportInterface>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                exportSocialProviders(): Promise<SocialProviderExportInterface>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                getSocialIdentityProviders(): Promise<SocialIdpSkeleton[]>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                getSocialProvider(providerId: string): Promise<SocialIdpSkeleton>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                importFirstSocialIdentityProvider(
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    importData: SocialProviderExportInterface,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    options: SocialIdentityProviderImportOptions,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                ): Promise<SocialIdpSkeleton>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                importFirstSocialProvider(
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    importData: SocialProviderExportInterface,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                ): Promise<boolean>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                importSocialIdentityProvider(
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    providerId: string,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    importData: SocialProviderExportInterface,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    options: SocialIdentityProviderImportOptions,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                ): Promise<SocialIdpSkeleton>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                importSocialIdentityProviders(
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    importData: SocialProviderExportInterface,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    options: SocialIdentityProviderImportOptions,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                ): Promise<SocialIdpSkeleton[]>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                importSocialProvider(
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    providerId: string,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    importData: SocialProviderExportInterface,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                ): Promise<boolean>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                importSocialProviders(
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    importData: SocialProviderExportInterface,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                ): Promise<boolean>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                putProviderByTypeAndId(
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    providerType: string,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    providerId: string,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    providerData: SocialIdpSkeleton,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                ): Promise<SocialIdpSkeleton>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                readSocialIdentityProvider(providerId: string): Promise<SocialIdpSkeleton>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                readSocialIdentityProviders(): Promise<SocialIdpSkeleton[]>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                updateSocialIdentityProvider(
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    providerType: string,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    providerId: string,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    providerData: SocialIdpSkeleton,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                ): Promise<SocialIdpSkeleton>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            }
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Index

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Methods

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            createSocialIdentityProvider +Idp | Frodo Library - v4.0.0-11
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Frodo Library - v4.0.0-11
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Type Alias Idp

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              type Idp = {
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  createSocialIdentityProvider(
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      providerType: string,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      providerId: string,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      providerData: SocialIdpSkeleton,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  ): Promise<SocialIdpSkeleton>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  deleteSocialIdentityProvider(
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      providerId: string,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  ): Promise<SocialIdpSkeleton>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  deleteSocialIdentityProviders(): Promise<SocialIdpSkeleton[]>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  deleteSocialProvider(providerId: string): Promise<SocialIdpSkeleton>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  exportSocialIdentityProvider(
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      providerId: string,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  ): Promise<SocialProviderExportInterface>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  exportSocialIdentityProviders(
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      options?: SocialIdentityProviderExportOptions,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  ): Promise<SocialProviderExportInterface>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  exportSocialProvider(
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      providerId: string,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  ): Promise<SocialProviderExportInterface>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  exportSocialProviders(): Promise<SocialProviderExportInterface>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  getSocialIdentityProviders(): Promise<SocialIdpSkeleton[]>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  getSocialProvider(providerId: string): Promise<SocialIdpSkeleton>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  importFirstSocialIdentityProvider(
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      importData: SocialProviderExportInterface,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      options: SocialIdentityProviderImportOptions,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  ): Promise<SocialIdpSkeleton>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  importFirstSocialProvider(
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      importData: SocialProviderExportInterface,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  ): Promise<boolean>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  importSocialIdentityProvider(
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      providerId: string,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      importData: SocialProviderExportInterface,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      options: SocialIdentityProviderImportOptions,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  ): Promise<SocialIdpSkeleton>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  importSocialIdentityProviders(
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      importData: SocialProviderExportInterface,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      options: SocialIdentityProviderImportOptions,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  ): Promise<SocialIdpSkeleton[]>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  importSocialProvider(
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      providerId: string,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      importData: SocialProviderExportInterface,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  ): Promise<boolean>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  importSocialProviders(
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      importData: SocialProviderExportInterface,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  ): Promise<boolean>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  putProviderByTypeAndId(
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      providerType: string,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      providerId: string,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      providerData: SocialIdpSkeleton,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  ): Promise<SocialIdpSkeleton>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  readSocialIdentityProvider(providerId: string): Promise<SocialIdpSkeleton>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  readSocialIdentityProviders(): Promise<SocialIdpSkeleton[]>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  updateSocialIdentityProvider(
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      providerType: string,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      providerId: string,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      providerData: SocialIdpSkeleton,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  ): Promise<SocialIdpSkeleton>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              }
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Index

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Methods

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • providerId: string

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              identity provider id/name

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • providerData: SocialIdpSkeleton

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              identity provider data

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • Returns Promise<SocialIdpSkeleton>

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              a promise that resolves a social identity provider object

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • Delete social identity provider

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • providerId: string

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  social identity provider id/name

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Returns Promise<SocialIdpSkeleton>

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                a promise that resolves a social identity provider object

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • Read social identity provider

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • providerId: string

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  identity provider id/name

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Returns Promise<SocialIdpSkeleton>

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                a promise that resolves a social identity provider object

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • Update or create social identity provider

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • providerType: string

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  identity provider type

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • providerId: string

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  identity provider id/name

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • providerData: SocialIdpSkeleton

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  identity provider data

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Returns Promise<SocialIdpSkeleton>

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                a promise that resolves a social identity provider object

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Deprecated

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Deprecated

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • Delete social identity provider

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • providerId: string

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  social identity provider id/name

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Returns Promise<SocialIdpSkeleton>

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                a promise that resolves to a social identity provider object

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                since v2.0.0 use deleteSocialIdentityProvider instead

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                deleteSocialIdentityProvider(providerId: string): Promise<SocialIdpSkeleton>
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                 
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              diff --git a/docs/types/Reference.Info.html b/docs/types/Reference.Info.html index 4388b10b0..0d716ab0f 100644 --- a/docs/types/Reference.Info.html +++ b/docs/types/Reference.Info.html @@ -1,4 +1,4 @@ -Info | Frodo Library - v4.0.0-10
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Frodo Library - v4.0.0-10
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Type Alias Info

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                type Info = {
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    getInfo(): Promise<PlatformInfo>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                }
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Index

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Methods

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                getInfo +Info | Frodo Library - v4.0.0-11
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Frodo Library - v4.0.0-11
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Type Alias Info

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  type Info = {
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      getInfo(): Promise<PlatformInfo>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  }
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Index

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Methods

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Methods

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • Get info about the platform instance

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Returns Promise<PlatformInfo>

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    a promise that resolves to a json blob with information about the instance and tokens

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  diff --git a/docs/types/Reference.JavaAgentType.html b/docs/types/Reference.JavaAgentType.html index cbc61db7a..4086c277d 100644 --- a/docs/types/Reference.JavaAgentType.html +++ b/docs/types/Reference.JavaAgentType.html @@ -1 +1 @@ -JavaAgentType | Frodo Library - v4.0.0-10
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Frodo Library - v4.0.0-10
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Type Alias JavaAgentType

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    JavaAgentType: "J2EEAgent"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    +JavaAgentType | Frodo Library - v4.0.0-11
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Frodo Library - v4.0.0-11
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Type Alias JavaAgentType

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      JavaAgentType: "J2EEAgent"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      diff --git a/docs/types/Reference.Jose.html b/docs/types/Reference.Jose.html index c62af67bc..ed7fb68c4 100644 --- a/docs/types/Reference.Jose.html +++ b/docs/types/Reference.Jose.html @@ -1,6 +1,6 @@ -Jose | Frodo Library - v4.0.0-10
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Frodo Library - v4.0.0-10
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Type Alias Jose

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        type Jose = {
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            createJwkRsa(): Promise<JwkRsa>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            createJwks(...keys: JwkInterface[]): JwksInterface;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            createSignedJwtToken(
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                payload: string | object,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                jwkJson: JwkRsa,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            ): Promise<any>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            getJwkRsaPublic(jwkJson: JwkRsa): Promise<JwkRsaPublic>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            verifySignedJwtToken(jwt: string, jwkJson: JwkRsaPublic): Promise<any>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        }
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Index

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Methods

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        createJwkRsa +Jose | Frodo Library - v4.0.0-11
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Frodo Library - v4.0.0-11
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Type Alias Jose

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          type Jose = {
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              createJwkRsa(): Promise<JwkRsa>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              createJwks(...keys: JwkInterface[]): JwksInterface;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              createSignedJwtToken(
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  payload: string | object,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  jwkJson: JwkRsa,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              ): Promise<any>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              getJwkRsaPublic(jwkJson: JwkRsa): Promise<JwkRsaPublic>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              verifySignedJwtToken(jwt: string, jwkJson: JwkRsaPublic): Promise<any>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          }
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Index

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Methods

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • payload: string | object
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • jwkJson: JwkRsa

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Returns Promise<any>

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Methods

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • payload: string | object
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • jwkJson: JwkRsa

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Returns Promise<any>

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          diff --git a/docs/types/Reference.Journey.html b/docs/types/Reference.Journey.html index 1017d247b..28a7adadf 100644 --- a/docs/types/Reference.Journey.html +++ b/docs/types/Reference.Journey.html @@ -1,4 +1,4 @@ -Journey | Frodo Library - v4.0.0-10
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Frodo Library - v4.0.0-10
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Type Alias Journey

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            type Journey = {
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                fileByIdTreeExportResolver: TreeExportResolverInterface;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                onlineTreeExportResolver: TreeExportResolverInterface;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                createFileParamTreeExportResolver(
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    file: string,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                ): TreeExportResolverInterface;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                createJourney(
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    journeyId: string,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    journeyData: TreeSkeleton,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                ): Promise<TreeSkeleton>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                createMultiTreeExportTemplate(): MultiTreeExportInterface;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                createSingleTreeExportTemplate(): SingleTreeExportInterface;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                deleteJourney(
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    journeyId: string,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    options: { deep: boolean; progress?: boolean; verbose: boolean },
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                ): Promise<DeleteJourneyStatus>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                deleteJourneys(
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    options: { deep: boolean; verbose: boolean },
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    resultCallback?: ResultCallback<DeleteJourneyStatus>,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                ): Promise<DeleteJourneysStatus>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                disableJourney(journeyId: string): Promise<TreeSkeleton>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                enableJourney(journeyId: string): Promise<TreeSkeleton>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                exportJourney(
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    treeId: string,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    options?: TreeExportOptions,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                ): Promise<SingleTreeExportInterface>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                exportJourneys(
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    options?: TreeExportOptions,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    resultCallback?: ResultCallback<SingleTreeExportInterface>,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                ): Promise<MultiTreeExportInterface>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                findOrphanedNodes(): Promise<NodeSkeleton[]>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                getJourney(journeyId: string): Promise<TreeSkeleton>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                getJourneyClassification(
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    journey: SingleTreeExportInterface,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                ): JourneyClassificationType[];
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                getJourneys(): Promise<TreeSkeleton[]>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                getNodeRef(
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    nodeObj: NodeSkeleton,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    singleTreeExport: SingleTreeExportInterface,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                ): NodeRefSkeletonInterface | InnerNodeRefSkeletonInterface;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                getTreeDescendents(
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    treeExport: SingleTreeExportInterface,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    resolveTreeExport: TreeExportResolverInterface,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    resolvedTreeIds?: string[],
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                ): Promise<TreeDependencyMapInterface>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                importAllJourneys(
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    importData: MultiTreeExportInterface,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    options: TreeImportOptions,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                ): Promise<TreeSkeleton[]>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                importJourney(
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    treeObject: SingleTreeExportInterface,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    options: TreeImportOptions,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                ): Promise<TreeSkeleton>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                importJourneys(
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    importData: MultiTreeExportInterface,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    options: TreeImportOptions,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    resultCallback?: ResultCallback<TreeSkeleton>,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                ): Promise<TreeSkeleton[]>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                isCloudOnlyJourney(journey: SingleTreeExportInterface): boolean;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                isCustomJourney(journey: SingleTreeExportInterface): boolean;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                isPremiumJourney(journey: SingleTreeExportInterface): boolean;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                readJourney(journeyId: string): Promise<TreeSkeleton>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                readJourneys(): Promise<TreeSkeleton[]>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                removeOrphanedNodes(orphanedNodes: NodeSkeleton[]): Promise<NodeSkeleton[]>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                resolveDependencies(
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    installedJorneys: any,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    journeyMap: any,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    unresolvedJourneys: any,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    resolvedJourneys: any,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    index?: number,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                ): Promise<void>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                updateJourney(
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    journeyId: string,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    journeyData: TreeSkeleton,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                ): Promise<TreeSkeleton>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            }
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Index

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Properties

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            fileByIdTreeExportResolver +Journey | Frodo Library - v4.0.0-11
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Frodo Library - v4.0.0-11
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Type Alias Journey

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              type Journey = {
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  fileByIdTreeExportResolver: TreeExportResolverInterface;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  onlineTreeExportResolver: TreeExportResolverInterface;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  createFileParamTreeExportResolver(
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      file: string,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  ): TreeExportResolverInterface;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  createJourney(
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      journeyId: string,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      journeyData: TreeSkeleton,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  ): Promise<TreeSkeleton>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  createMultiTreeExportTemplate(): MultiTreeExportInterface;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  createSingleTreeExportTemplate(): SingleTreeExportInterface;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  deleteJourney(
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      journeyId: string,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      options: { deep: boolean; progress?: boolean; verbose: boolean },
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  ): Promise<DeleteJourneyStatus>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  deleteJourneys(
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      options: { deep: boolean; verbose: boolean },
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      resultCallback?: ResultCallback<DeleteJourneyStatus>,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  ): Promise<DeleteJourneysStatus>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  disableJourney(journeyId: string): Promise<TreeSkeleton>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  enableJourney(journeyId: string): Promise<TreeSkeleton>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  exportJourney(
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      treeId: string,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      options?: TreeExportOptions,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  ): Promise<SingleTreeExportInterface>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  exportJourneys(
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      options?: TreeExportOptions,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      resultCallback?: ResultCallback<SingleTreeExportInterface>,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  ): Promise<MultiTreeExportInterface>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  findOrphanedNodes(): Promise<NodeSkeleton[]>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  getJourney(journeyId: string): Promise<TreeSkeleton>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  getJourneyClassification(
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      journey: SingleTreeExportInterface,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  ): JourneyClassificationType[];
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  getJourneys(): Promise<TreeSkeleton[]>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  getNodeRef(
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      nodeObj: NodeSkeleton,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      singleTreeExport: SingleTreeExportInterface,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  ): NodeRefSkeletonInterface | InnerNodeRefSkeletonInterface;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  getTreeDescendents(
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      treeExport: SingleTreeExportInterface,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      resolveTreeExport: TreeExportResolverInterface,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      resolvedTreeIds?: string[],
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  ): Promise<TreeDependencyMapInterface>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  importAllJourneys(
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      importData: MultiTreeExportInterface,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      options: TreeImportOptions,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  ): Promise<TreeSkeleton[]>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  importJourney(
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      treeObject: SingleTreeExportInterface,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      options: TreeImportOptions,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  ): Promise<TreeSkeleton>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  importJourneys(
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      importData: MultiTreeExportInterface,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      options: TreeImportOptions,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      resultCallback?: ResultCallback<TreeSkeleton>,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  ): Promise<TreeSkeleton[]>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  isCloudOnlyJourney(journey: SingleTreeExportInterface): boolean;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  isCustomJourney(journey: SingleTreeExportInterface): boolean;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  isPremiumJourney(journey: SingleTreeExportInterface): boolean;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  readJourney(journeyId: string): Promise<TreeSkeleton>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  readJourneys(): Promise<TreeSkeleton[]>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  removeOrphanedNodes(orphanedNodes: NodeSkeleton[]): Promise<NodeSkeleton[]>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  resolveDependencies(
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      installedJorneys: any,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      journeyMap: any,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      unresolvedJourneys: any,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      resolvedJourneys: any,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      index?: number,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  ): Promise<void>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  updateJourney(
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      journeyId: string,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      journeyData: TreeSkeleton,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  ): Promise<TreeSkeleton>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              }
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Index

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Properties

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Methods

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              createFileParamTreeExportResolver createJourney @@ -31,42 +31,42 @@ of that tree from individual treename.journey.json export files.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              id/name of the tree to resolve

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              tree export

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              onlineTreeExportResolver: TreeExportResolverInterface

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Default tree export resolver used to resolve a tree id/name to a full export +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              onlineTreeExportResolver: TreeExportResolverInterface

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Default tree export resolver used to resolve a tree id/name to a full export w/o dependencies of that tree from a platform instance.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              id/name of the tree to resolve

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              tree export

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Methods

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Methods

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • Delete a journey

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • journeyId: string

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  journey id/name

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • options: { deep: boolean; progress?: boolean; verbose: boolean }

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  deep=true also delete all the nodes and inner nodes, verbose=true print verbose info

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Returns Promise<DeleteJourneyStatus>

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Returns Promise<DeleteJourneyStatus>

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Returns Promise<DeleteJourneysStatus>

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Returns Promise<TreeSkeleton[]>

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Returns Promise<void>

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Deprecated

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Deprecated

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • Get a journey/tree without all its nodes and dependencies.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • journeyId: string

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  journey id/name

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Returns Promise<TreeSkeleton>

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                a promise that resolves to a journey object

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                since v2.0.0 use readJourney instead

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                readJourney(journeyId: string): Promise<TreeSkeleton>
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                 
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • Get all the journeys/trees without all their nodes and dependencies.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Returns Promise<TreeSkeleton[]>

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                a promise that resolves to an array of journey objects

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                since v2.0.0 use readJourneys instead

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                readJourneys(): Promise<TreeSkeleton[]>
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                 
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              diff --git a/docs/types/Reference.JourneyClassificationType.html b/docs/types/Reference.JourneyClassificationType.html index 790201ab3..3d53852f0 100644 --- a/docs/types/Reference.JourneyClassificationType.html +++ b/docs/types/Reference.JourneyClassificationType.html @@ -1 +1 @@ -JourneyClassificationType | Frodo Library - v4.0.0-10
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Frodo Library - v4.0.0-10
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Type Alias JourneyClassificationType

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                JourneyClassificationType: "standard" | "custom" | "cloud" | "premium"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                +JourneyClassificationType | Frodo Library - v4.0.0-11
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Frodo Library - v4.0.0-11
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Type Alias JourneyClassificationType

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  JourneyClassificationType: "standard" | "custom" | "cloud" | "premium"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  diff --git a/docs/types/Reference.Json.html b/docs/types/Reference.Json.html index 99a2f4767..86e654427 100644 --- a/docs/types/Reference.Json.html +++ b/docs/types/Reference.Json.html @@ -1,4 +1,4 @@ -Json | Frodo Library - v4.0.0-10
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Frodo Library - v4.0.0-10
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Type Alias Json

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    type Json = {
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        cloneDeep(obj: any): any;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        deleteDeepByKey(object: any, substring: any): any;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        findInArray(objs: any[], predicate: any): any;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        get(obj: any, path: string[], defaultValue?: any): any;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        getPaths(o: any, prefix?: string, delim?: string): string[];
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        isEqualJson(obj1: object, obj2: object, ignoreKeys?: string[]): boolean;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        mergeDeep(obj1: any, obj2: any): any;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        put(obj: any, value: any, path: string[]): any;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        stringify(obj: any): string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    }
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Index

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Methods

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    cloneDeep +Json | Frodo Library - v4.0.0-11
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Frodo Library - v4.0.0-11
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Type Alias Json

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      type Json = {
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          cloneDeep(obj: any): any;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          deleteDeepByKey(object: any, substring: any): any;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          findInArray(objs: any[], predicate: any): any;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          get(obj: any, path: string[], defaultValue?: any): any;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          getPaths(o: any, prefix?: string, delim?: string): string[];
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          isEqualJson(obj1: object, obj2: object, ignoreKeys?: string[]): boolean;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          mergeDeep(obj1: any, obj2: any): any;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          put(obj: any, value: any, path: string[]): any;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          stringify(obj: any): string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      }
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Index

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Methods

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Methods

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • Deep clone object

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • obj: any

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          object to deep clone

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Returns any

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        new object cloned from obj

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • Deep delete keys and their values from an input object. If a key in object contains substring, the key an its value is deleted.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • Deep delete keys and their values from an input object. If a key in object contains substring, the key an its value is deleted.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • object: any

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          input object that needs keys removed

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • substring: any

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          substring to search for in key

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Returns any

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        the modified object without the matching keys and their values

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • objs: any[]
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • predicate: any

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Returns any

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • obj: any
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • path: string[]
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • OptionaldefaultValue: any

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Returns any

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • Get all paths for an object

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • objs: any[]
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • predicate: any

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Returns any

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • obj: any
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • path: string[]
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • OptionaldefaultValue: any

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Returns any

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • Get all paths for an object

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • o: any

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          object

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • Optionalprefix: string

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          prefix (path calculated up to this point). Only needed for recursion or to add a global prefix to all paths.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • Optionaldelim: string

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          delimiter used to separate elements of the path. Default is '.'.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Returns string[]

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        an array of paths

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • Compare two json objects

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • Compare two json objects

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • obj1: object

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          object 1

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • obj2: object

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          object 2

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • OptionalignoreKeys: string[]

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          array of keys to ignore in comparison

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Returns boolean

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        true if the two json objects have the same length and all the properties have the same value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • Deep merge two objects

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • obj1: any

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          first object

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • obj2: any

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          second object

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Returns any

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        merged first and second object

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • obj: any
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • value: any
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • path: string[]

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Returns any

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • obj: any
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • value: any
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • path: string[]

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Returns any

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • Deterministic stringify

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • obj: any

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          json object to stringify deterministically

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Returns string

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        stringified json object

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      diff --git a/docs/types/Reference.JwkRsa.html b/docs/types/Reference.JwkRsa.html index 36595832d..49c22cf2d 100644 --- a/docs/types/Reference.JwkRsa.html +++ b/docs/types/Reference.JwkRsa.html @@ -1 +1 @@ -JwkRsa | Frodo Library - v4.0.0-10
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Frodo Library - v4.0.0-10
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Type Alias JwkRsa

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        JwkRsa: JwkInterface & {
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            d: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            dp: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            dq: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            e: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            n: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            p: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            q: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            qi: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        }
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        +JwkRsa | Frodo Library - v4.0.0-11
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Frodo Library - v4.0.0-11
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Type Alias JwkRsa

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          JwkRsa: JwkInterface & {
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              d: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              dp: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              dq: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              e: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              n: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              p: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              q: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              qi: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          }
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          diff --git a/docs/types/Reference.JwkRsaPublic.html b/docs/types/Reference.JwkRsaPublic.html index 57daba504..efb0534a2 100644 --- a/docs/types/Reference.JwkRsaPublic.html +++ b/docs/types/Reference.JwkRsaPublic.html @@ -1 +1 @@ -JwkRsaPublic | Frodo Library - v4.0.0-10
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Frodo Library - v4.0.0-10
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Type Alias JwkRsaPublic

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            JwkRsaPublic: JwkInterface & { e: string; n: string }
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            +JwkRsaPublic | Frodo Library - v4.0.0-11
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Frodo Library - v4.0.0-11
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Type Alias JwkRsaPublic

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              JwkRsaPublic: JwkInterface & { e: string; n: string }
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              diff --git a/docs/types/Reference.Log.html b/docs/types/Reference.Log.html index 93081a795..d4c4a97f5 100644 --- a/docs/types/Reference.Log.html +++ b/docs/types/Reference.Log.html @@ -1,4 +1,4 @@ -Log | Frodo Library - v4.0.0-10
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Frodo Library - v4.0.0-10
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Type Alias Log

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                type Log = {
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    createLogApiKey(keyName: string): Promise<LogApiKey>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    deleteLogApiKey(keyId: string): Promise<LogApiKey>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    deleteLogApiKeys(): Promise<LogApiKey[]>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    fetch(
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        source: string,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        startTs: string,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        endTs: string,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        cookie: string,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        txid: string,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        filter: string,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    ): Promise<PagedResult<LogEventSkeleton>>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    getDefaultNoiseFilter(): string[];
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    getLogApiKey(keyId: string): Promise<LogApiKey>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    getLogApiKeys(): Promise<LogApiKey[]>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    getLogSources(): Promise<string[]>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    isLogApiKeyValid(keyId: string, secret: string): Promise<boolean>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    resolveLevel(level: string | number): string[];
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    resolvePayloadLevel(log: LogEventSkeleton): string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    tail(
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        source: string,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        cookie: string,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    ): Promise<PagedResult<LogEventSkeleton>>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                }
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Index

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Methods

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                createLogApiKey +Log | Frodo Library - v4.0.0-11
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Frodo Library - v4.0.0-11
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Type Alias Log

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  type Log = {
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      createLogApiKey(keyName: string): Promise<LogApiKey>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      deleteLogApiKey(keyId: string): Promise<LogApiKey>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      deleteLogApiKeys(): Promise<LogApiKey[]>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      fetch(
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          source: string,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          startTs: string,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          endTs: string,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          cookie: string,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          txid: string,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          filter: string,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      ): Promise<PagedResult<LogEventSkeleton>>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      getDefaultNoiseFilter(): string[];
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      getLogApiKey(keyId: string): Promise<LogApiKey>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      getLogApiKeys(): Promise<LogApiKey[]>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      getLogSources(): Promise<string[]>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      isLogApiKeyValid(keyId: string, secret: string): Promise<boolean>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      resolveLevel(level: string | number): string[];
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      resolvePayloadLevel(log: LogEventSkeleton): string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      tail(
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          source: string,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          cookie: string,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      ): Promise<PagedResult<LogEventSkeleton>>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  }
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Index

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Methods

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • Create log api key

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • keyName: string

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      human-readable key name

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Returns Promise<LogApiKey>

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    a promise resolving to an object containing the log api key and secret

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • Delete log api key

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • keyId: string

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      key id

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Returns Promise<LogApiKey>

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    a promise resolving to an object containing the log api key

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • Fetch logs

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • source: string

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      log source(s) to tail

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • startTs: string

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      start timestamp

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • endTs: string

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      end timestamp

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      @@ -26,27 +26,27 @@
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • txid: string

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      transaction id

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • filter: string

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      query filter

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Returns Promise<PagedResult<LogEventSkeleton>>

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    promise resolving to paged log event result

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • Get default noise filter

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Returns string[]

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    array of default event types and loggers to be filtered out

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • Get available log sources

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Returns Promise<string[]>

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    promise resolving to an array of available log sources

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • Validate log api key and secret

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • Validate log api key and secret

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • keyId: string

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      log api key id

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • secret: string

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      log api secret

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Returns Promise<boolean>

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    a promise resolving to true if the key is valid, false otherwise

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • Resolve log level to an array of effective log levels

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • Resolve log level to an array of effective log levels

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • level: string | number

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      string or numeric log level: 'FATAL', 'ERROR', 'WARN', 'INFO', 'DEBUG', 'TRACE', 'ALL', 0, 1, 2, 3, 4

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Returns string[]

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    array of effective log levels

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  diff --git a/docs/types/Reference.LogApiKey.html b/docs/types/Reference.LogApiKey.html index 99cc921e5..ddc8b0e32 100644 --- a/docs/types/Reference.LogApiKey.html +++ b/docs/types/Reference.LogApiKey.html @@ -1,5 +1,5 @@ -LogApiKey | Frodo Library - v4.0.0-10
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Frodo Library - v4.0.0-10
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Type Alias LogApiKey

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    type LogApiKey = {
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        api_key_id: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        api_key_secret?: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        created_at: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        name: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    }
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Index

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Properties

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    api_key_id +LogApiKey | Frodo Library - v4.0.0-11
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Frodo Library - v4.0.0-11
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Type Alias LogApiKey

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      type LogApiKey = {
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          api_key_id: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          api_key_secret?: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          created_at: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          name: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      }
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Index

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Properties

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      api_key_id: string
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      api_key_secret?: string
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      created_at: string
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      name: string
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Properties

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      api_key_id: string
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      api_key_secret?: string
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      created_at: string
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      name: string
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      diff --git a/docs/types/Reference.LogEventPayloadSkeleton.html b/docs/types/Reference.LogEventPayloadSkeleton.html index c48a5065b..e8eb1f03f 100644 --- a/docs/types/Reference.LogEventPayloadSkeleton.html +++ b/docs/types/Reference.LogEventPayloadSkeleton.html @@ -1 +1 @@ -LogEventPayloadSkeleton | Frodo Library - v4.0.0-10
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Frodo Library - v4.0.0-10
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Type Alias LogEventPayloadSkeleton

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        LogEventPayloadSkeleton: NoIdObjectSkeletonInterface & {
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            context: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            level: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            logger: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            mdc: { transactionId: string };
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            message: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            thread: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            timestamp: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            transactionId: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        }
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        +LogEventPayloadSkeleton | Frodo Library - v4.0.0-11
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Frodo Library - v4.0.0-11
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Type Alias LogEventPayloadSkeleton

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          LogEventPayloadSkeleton: NoIdObjectSkeletonInterface & {
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              context: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              level: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              logger: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              mdc: { transactionId: string };
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              message: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              thread: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              timestamp: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              transactionId: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          }
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          diff --git a/docs/types/Reference.LogEventSkeleton.html b/docs/types/Reference.LogEventSkeleton.html index bb15dc41e..a972d1e20 100644 --- a/docs/types/Reference.LogEventSkeleton.html +++ b/docs/types/Reference.LogEventSkeleton.html @@ -1 +1 @@ -LogEventSkeleton | Frodo Library - v4.0.0-10
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Frodo Library - v4.0.0-10
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Type Alias LogEventSkeleton

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            LogEventSkeleton: NoIdObjectSkeletonInterface & {
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                payload: string | LogEventPayloadSkeleton;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                source: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                timestamp: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                type: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            }
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            +LogEventSkeleton | Frodo Library - v4.0.0-11
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Frodo Library - v4.0.0-11
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Type Alias LogEventSkeleton

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              LogEventSkeleton: NoIdObjectSkeletonInterface & {
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  payload: string | LogEventPayloadSkeleton;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  source: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  timestamp: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  type: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              }
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              diff --git a/docs/types/Reference.ManagedObject.html b/docs/types/Reference.ManagedObject.html index e4d528f0a..2c8601c6d 100644 --- a/docs/types/Reference.ManagedObject.html +++ b/docs/types/Reference.ManagedObject.html @@ -1,4 +1,4 @@ -ManagedObject | Frodo Library - v4.0.0-10
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Frodo Library - v4.0.0-10
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Type Alias ManagedObject

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                type ManagedObject = {
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    createManagedObject(
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        type: string,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        moData: IdObjectSkeletonInterface,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        id?: string,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    ): Promise<IdObjectSkeletonInterface>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    deleteManagedObject(
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        type: string,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        id: string,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    ): Promise<IdObjectSkeletonInterface>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    deleteManagedObjects(type: string, filter: string): Promise<number>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    queryManagedObjects(
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        type: string,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        filter?: string,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        fields?: string[],
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        pageSize?: number,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    ): Promise<IdObjectSkeletonInterface[]>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    readManagedObject(
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        type: string,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        id: string,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        fields: string[],
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    ): Promise<IdObjectSkeletonInterface>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    readManagedObjects(
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        type: string,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        fields: string[],
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    ): Promise<IdObjectSkeletonInterface[]>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    resolveFullName(type: string, id: string): Promise<string>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    resolvePerpetratorUuid(id: string): Promise<string>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    resolveUserName(type: string, id: string): Promise<string>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    updateManagedObject(
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        type: string,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        id: string,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        moData: IdObjectSkeletonInterface,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    ): Promise<IdObjectSkeletonInterface>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    updateManagedObjectProperties(
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        type: string,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        id: string,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        operations: PatchOperationInterface[],
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        rev?: string,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    ): Promise<IdObjectSkeletonInterface>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    updateManagedObjectsProperties(
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        type: string,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        filter: string,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        operations: PatchOperationInterface[],
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        rev?: string,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        pageSize?: number,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    ): Promise<IdObjectSkeletonInterface[]>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                }
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Index

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Methods

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                createManagedObject +ManagedObject | Frodo Library - v4.0.0-11
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Frodo Library - v4.0.0-11
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Type Alias ManagedObject

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  type ManagedObject = {
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      createManagedObject(
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          type: string,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          moData: IdObjectSkeletonInterface,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          id?: string,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      ): Promise<IdObjectSkeletonInterface>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      deleteManagedObject(
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          type: string,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          id: string,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      ): Promise<IdObjectSkeletonInterface>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      deleteManagedObjects(type: string, filter: string): Promise<number>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      queryManagedObjects(
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          type: string,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          filter?: string,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          fields?: string[],
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          pageSize?: number,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      ): Promise<IdObjectSkeletonInterface[]>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      readManagedObject(
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          type: string,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          id: string,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          fields: string[],
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      ): Promise<IdObjectSkeletonInterface>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      readManagedObjects(
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          type: string,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          fields: string[],
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      ): Promise<IdObjectSkeletonInterface[]>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      resolveFullName(type: string, id: string): Promise<string>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      resolvePerpetratorUuid(id: string): Promise<string>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      resolveUserName(type: string, id: string): Promise<string>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      updateManagedObject(
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          type: string,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          id: string,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          moData: IdObjectSkeletonInterface,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      ): Promise<IdObjectSkeletonInterface>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      updateManagedObjectProperties(
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          type: string,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          id: string,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          operations: PatchOperationInterface[],
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          rev?: string,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      ): Promise<IdObjectSkeletonInterface>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      updateManagedObjectsProperties(
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          type: string,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          filter: string,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          operations: PatchOperationInterface[],
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          rev?: string,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          pageSize?: number,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      ): Promise<IdObjectSkeletonInterface[]>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  }
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Index

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Methods

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • type: string

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    managed object type, e.g. teammember or alpha_user

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • moData: IdObjectSkeletonInterface

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    managed object data

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • Optionalid: string

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    managed object _id

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Returns Promise<IdObjectSkeletonInterface>

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Returns Promise<IdObjectSkeletonInterface>

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • Delete managed objects by filter

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • Delete managed objects by filter

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • type: string

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      managed object type, e.g. alpha_user or user

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • filter: string

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      filter

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Returns Promise<number>

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    a promise that resolves the number of deleted objects

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • Query managed objects

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • type: string

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      managed object type, e.g. alpha_user or user

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • Optionalfilter: string

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      CREST search filter

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • Optionalfields: string[]

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      array of fields to return

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • OptionalpageSize: number

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Returns Promise<IdObjectSkeletonInterface[]>

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    a promise resolving to an array of managed objects

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • Read managed object

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • type: string

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      managed object type, e.g. alpha_user or user

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • id: string

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      managed object id

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • fields: string[]

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Returns Promise<IdObjectSkeletonInterface>

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    a promise that resolves to an IdObjectSkeletonInterface

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • Read all managed object of the specified type

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • type: string

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      managed object type, e.g. alpha_user or user

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • fields: string[]

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      array of fields to return

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Returns Promise<IdObjectSkeletonInterface[]>

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    a promise that resolves to an array of IdObjectSkeletonInterfaces

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • Resolve a managed object's uuid to a human readable full name

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • Resolve a managed object's uuid to a human readable full name

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • type: string

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      managed object type, e.g. teammember or alpha_user

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • id: string

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      managed object _id

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Returns Promise<string>

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    resolved full name or uuid if any error occurs during reslution

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • Resolve a perpetrator's uuid to a human readable string identifying the perpetrator

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • Resolve a perpetrator's uuid to a human readable string identifying the perpetrator

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • id: string

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      managed object _id

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Returns Promise<string>

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    resolved perpetrator descriptive string or uuid if any error occurs during reslution

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • Resolve a managed object's uuid to a human readable username

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • Resolve a managed object's uuid to a human readable username

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • type: string

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      managed object type, e.g. teammember or alpha_user

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • id: string

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      managed object _id

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Returns Promise<string>

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    resolved username or uuid if any error occurs during reslution

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • Partially update managed object through a collection of patch operations.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • type: string

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      managed object type, e.g. alpha_user or user

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • id: string

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      managed object id

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • operations: PatchOperationInterface[]

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      collection of patch operations to perform on the object

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • Optionalrev: string

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      managed object revision

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Returns Promise<IdObjectSkeletonInterface>

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    a promise that resolves to an IdObjectSkeletonInterface

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • Partially update multiple managed object through a collection of patch operations.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • type: string

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      managed object type, e.g. alpha_user or user

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • filter: string

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      CREST search filter

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • operations: PatchOperationInterface[]

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      collection of patch operations to perform on the object

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • Optionalrev: string

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      managed object revision

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • OptionalpageSize: number

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      page size

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Returns Promise<IdObjectSkeletonInterface[]>

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    a promise that resolves to an IdObjectSkeletonInterface

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  diff --git a/docs/types/Reference.Mapping.html b/docs/types/Reference.Mapping.html index 202ca595a..9e47a4ef8 100644 --- a/docs/types/Reference.Mapping.html +++ b/docs/types/Reference.Mapping.html @@ -1,4 +1,4 @@ -Mapping | Frodo Library - v4.0.0-10
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Frodo Library - v4.0.0-10
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Type Alias Mapping

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    type Mapping = {
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        createMapping(
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            mappingId: string,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            mappingData: MappingSkeleton,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        ): Promise<MappingSkeleton>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        createMappingExportTemplate(): MappingExportInterface;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        deleteMapping(mappingId: string): Promise<MappingSkeleton>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        deleteMappings(
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            connectorId?: string,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            moType?: string,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        ): Promise<MappingSkeleton[]>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        exportMapping(
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            mappingId: string,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            options?: MappingExportOptions,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        ): Promise<MappingExportInterface>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        exportMappings(
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            options?: MappingExportOptions,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        ): Promise<MappingExportInterface>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        importFirstMapping(
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            importData: MappingExportInterface,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            options?: MappingImportOptions,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        ): Promise<MappingSkeleton>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        importMapping(
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            mappingId: string,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            importData: MappingExportInterface,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            options?: MappingImportOptions,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        ): Promise<MappingSkeleton>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        importMappings(
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            importData: MappingExportInterface,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            options?: MappingImportOptions,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        ): Promise<MappingSkeleton[]>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        isLegacyMapping(mappingId: string): boolean;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        readMapping(mappingId: string): Promise<MappingSkeleton>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        readMappings(
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            connectorId?: string,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            moType?: string,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        ): Promise<MappingSkeleton[]>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        readSyncMappings(): Promise<MappingSkeleton[]>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        updateMapping(
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            mappingId: string,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            mappingData: MappingSkeleton,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        ): Promise<MappingSkeleton>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        updateSyncMappings(mappings: MappingSkeleton[]): Promise<MappingSkeleton[]>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    }
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Index

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Methods

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    createMapping +Mapping | Frodo Library - v4.0.0-11
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Frodo Library - v4.0.0-11
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Type Alias Mapping

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      type Mapping = {
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          createMapping(
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              mappingId: string,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              mappingData: MappingSkeleton,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          ): Promise<MappingSkeleton>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          createMappingExportTemplate(): MappingExportInterface;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          deleteMapping(mappingId: string): Promise<MappingSkeleton>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          deleteMappings(
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              connectorId?: string,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              moType?: string,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          ): Promise<MappingSkeleton[]>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          exportMapping(
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              mappingId: string,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              options?: MappingExportOptions,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          ): Promise<MappingExportInterface>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          exportMappings(
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              options?: MappingExportOptions,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          ): Promise<MappingExportInterface>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          importFirstMapping(
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              importData: MappingExportInterface,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              options?: MappingImportOptions,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          ): Promise<MappingSkeleton>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          importMapping(
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              mappingId: string,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              importData: MappingExportInterface,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              options?: MappingImportOptions,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          ): Promise<MappingSkeleton>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          importMappings(
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              importData: MappingExportInterface,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              options?: MappingImportOptions,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          ): Promise<MappingSkeleton[]>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          isLegacyMapping(mappingId: string): boolean;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          readMapping(mappingId: string): Promise<MappingSkeleton>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          readMappings(
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              connectorId?: string,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              moType?: string,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          ): Promise<MappingSkeleton[]>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          readSyncMappings(): Promise<MappingSkeleton[]>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          updateMapping(
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              mappingId: string,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              mappingData: MappingSkeleton,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          ): Promise<MappingSkeleton>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          updateSyncMappings(mappings: MappingSkeleton[]): Promise<MappingSkeleton[]>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      }
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Index

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Methods

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • mappingId: string

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        id of the mapping (new: 'mapping/<name>', legacy: 'sync/<name>')

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • mappingData: MappingSkeleton

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        mapping object

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Returns Promise<MappingSkeleton>

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      a promise that resolves to an mapping object

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • Delete mapping

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • mappingId: string

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          id of the mapping (new: 'mapping/<name>', legacy: 'sync/<name>')

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Returns Promise<MappingSkeleton>

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        a promise that resolves an mapping object

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • Delete all mappings

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • OptionalconnectorId: string

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          limit mappings to connector

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • OptionalmoType: string

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          limit mappings to managed object type

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Returns Promise<MappingSkeleton[]>

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        a promise that resolves to an array of mapping objects

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • Helper that returns a boolean indicating whether the mapping is a legacy mapping or not given the id

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • Helper that returns a boolean indicating whether the mapping is a legacy mapping or not given the id

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • mappingId: string

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          the mapping id

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Returns boolean

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        true if the mapping is a legacy mapping, false otherwise

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        if the id is invalid

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • Read mapping

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • mappingId: string

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          id of the mapping (new: 'mapping/<name>', legacy: 'sync/<name>')

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Returns Promise<MappingSkeleton>

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        a promise that resolves an mapping object

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • Read mappings

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • OptionalconnectorId: string

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          limit mappings to connector

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • OptionalmoType: string

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          limit mappings to managed object type

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Returns Promise<MappingSkeleton[]>

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        a promise that resolves to an array of mapping objects

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      diff --git a/docs/types/Reference.MappingPolicy.html b/docs/types/Reference.MappingPolicy.html index 1eed232ba..4f87a0753 100644 --- a/docs/types/Reference.MappingPolicy.html +++ b/docs/types/Reference.MappingPolicy.html @@ -1,3 +1,3 @@ -MappingPolicy | Frodo Library - v4.0.0-10
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Frodo Library - v4.0.0-10
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Type Alias MappingPolicy

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        type MappingPolicy = {
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            action: "CREATE" | "DELETE" | "EXCEPTION" | "IGNORE" | "UPDATE";
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            situation:
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                | "ABSENT"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                | "ALL_GONE"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                | "AMBIGUOUS"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                | "CONFIRMED"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                | "FOUND"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                | "FOUND_ALREADY_LINKED"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                | "LINK_ONLY"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                | "MISSING"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                | "SOURCE_IGNORED"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                | "SOURCE_MISSING"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                | "TARGET_IGNORED"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                | "UNASSIGNED"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                | "UNQUALIFIED";
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        }
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Index

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Properties

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        action +MappingPolicy | Frodo Library - v4.0.0-11
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Frodo Library - v4.0.0-11
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Type Alias MappingPolicy

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          type MappingPolicy = {
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              action: "CREATE" | "DELETE" | "EXCEPTION" | "IGNORE" | "UPDATE";
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              situation:
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  | "ABSENT"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  | "ALL_GONE"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  | "AMBIGUOUS"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  | "CONFIRMED"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  | "FOUND"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  | "FOUND_ALREADY_LINKED"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  | "LINK_ONLY"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  | "MISSING"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  | "SOURCE_IGNORED"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  | "SOURCE_MISSING"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  | "TARGET_IGNORED"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  | "UNASSIGNED"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  | "UNQUALIFIED";
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          }
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Index

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Properties

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Properties

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          action: "CREATE" | "DELETE" | "EXCEPTION" | "IGNORE" | "UPDATE"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          situation:
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              | "ABSENT"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              | "ALL_GONE"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              | "AMBIGUOUS"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              | "CONFIRMED"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              | "FOUND"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              | "FOUND_ALREADY_LINKED"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              | "LINK_ONLY"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              | "MISSING"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              | "SOURCE_IGNORED"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              | "SOURCE_MISSING"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              | "TARGET_IGNORED"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              | "UNASSIGNED"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              | "UNQUALIFIED"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Properties

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          action: "CREATE" | "DELETE" | "EXCEPTION" | "IGNORE" | "UPDATE"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          situation:
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              | "ABSENT"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              | "ALL_GONE"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              | "AMBIGUOUS"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              | "CONFIRMED"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              | "FOUND"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              | "FOUND_ALREADY_LINKED"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              | "LINK_ONLY"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              | "MISSING"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              | "SOURCE_IGNORED"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              | "SOURCE_MISSING"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              | "TARGET_IGNORED"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              | "UNASSIGNED"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              | "UNQUALIFIED"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          diff --git a/docs/types/Reference.MappingProperty.html b/docs/types/Reference.MappingProperty.html index 8feefecc0..db4fa836a 100644 --- a/docs/types/Reference.MappingProperty.html +++ b/docs/types/Reference.MappingProperty.html @@ -1,4 +1,4 @@ -MappingProperty | Frodo Library - v4.0.0-10
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Frodo Library - v4.0.0-10
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Type Alias MappingProperty

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            type MappingProperty = {
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                source?: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                target: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                transform?: { globals: any; source: string; type: string };
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            }
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Index

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Properties

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            source? +MappingProperty | Frodo Library - v4.0.0-11
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Frodo Library - v4.0.0-11
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Type Alias MappingProperty

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              type MappingProperty = {
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  source?: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  target: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  transform?: { globals: any; source: string; type: string };
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              }
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Index

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Properties

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              source?: string
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              target: string
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              transform?: { globals: any; source: string; type: string }
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Properties

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              source?: string
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              target: string
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              transform?: { globals: any; source: string; type: string }
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              diff --git a/docs/types/Reference.MappingSkeleton.html b/docs/types/Reference.MappingSkeleton.html index 488d0a15f..75becd8bf 100644 --- a/docs/types/Reference.MappingSkeleton.html +++ b/docs/types/Reference.MappingSkeleton.html @@ -1 +1 @@ -MappingSkeleton | Frodo Library - v4.0.0-10
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Frodo Library - v4.0.0-10
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Type Alias MappingSkeleton

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                MappingSkeleton: IdObjectSkeletonInterface & {
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    consentRequired?: boolean;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    displayName?: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    linkQualifiers?: string[];
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    name: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    policies?: MappingPolicy[];
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    properties?: MappingProperty[];
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    source?: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    syncAfter?: string[];
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    target?: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                }
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                +MappingSkeleton | Frodo Library - v4.0.0-11
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Frodo Library - v4.0.0-11
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Type Alias MappingSkeleton

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  MappingSkeleton: IdObjectSkeletonInterface & {
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      consentRequired?: boolean;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      displayName?: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      linkQualifiers?: string[];
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      name: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      policies?: MappingPolicy[];
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      properties?: MappingProperty[];
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      source?: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      syncAfter?: string[];
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      target?: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  }
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  diff --git a/docs/types/Reference.Node.html b/docs/types/Reference.Node.html index 4ddc6ba46..2b72e79cd 100644 --- a/docs/types/Reference.Node.html +++ b/docs/types/Reference.Node.html @@ -1,4 +1,4 @@ -Node | Frodo Library - v4.0.0-10
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Frodo Library - v4.0.0-10
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Type Alias Node

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    type Node = {
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        createNode(
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            nodeType: string,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            nodeData: NodeSkeleton,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        ): Promise<NodeSkeleton>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        deleteCustomNode(
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            nodeId?: string,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            nodeName?: string,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        ): Promise<CustomNodeSkeleton>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        deleteCustomNodes(
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            resultCallback?: ResultCallback<CustomNodeSkeleton>,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        ): Promise<CustomNodeSkeleton[]>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        deleteNode(nodeId: string, nodeType: string): Promise<NodeSkeleton>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        exportCustomNode(
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            nodeId?: string,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            nodeName?: string,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            options?: CustomNodeExportOptions,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        ): Promise<CustomNodeExportInterface>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        exportCustomNodes(
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            options?: CustomNodeExportOptions,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        ): Promise<CustomNodeExportInterface>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        exportNodes(): Promise<NodeExportInterface>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        findOrphanedNodes(): Promise<NodeSkeleton[]>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        getCustomNodeUsage(nodeId: string): Promise<CustomNodeUsage>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        getNodeClassification(nodeType: string): NodeClassificationType[];
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        importCustomNodes(
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            nodeId: string,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            nodeName: string,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            importData: CustomNodeExportInterface,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            options?: CustomNodeImportOptions,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            resultCallback?: ResultCallback<CustomNodeSkeleton>,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        ): Promise<CustomNodeSkeleton[]>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        isCloudExcludedNode(nodeType: string): boolean;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        isCloudOnlyNode(nodeType: string): boolean;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        isCustomNode(nodeType: string): boolean;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        isDeprecatedNode(nodeType: string): boolean;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        isPremiumNode(nodeType: string): boolean;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        readCustomNode(
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            nodeId?: string,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            nodeName?: string,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        ): Promise<CustomNodeSkeleton>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        readCustomNodes(): Promise<CustomNodeSkeleton[]>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        readNode(nodeId: string, nodeType: string): Promise<NodeSkeleton>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        readNodes(): Promise<NodeSkeleton[]>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        readNodesByType(nodeType: string): Promise<NodeSkeleton[]>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        readNodeTypes(): Promise<any>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        removeOrphanedNodes(orphanedNodes: NodeSkeleton[]): Promise<NodeSkeleton[]>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        updateCustomNode(
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            nodeId: string,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            nodeData: CustomNodeSkeleton,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        ): Promise<CustomNodeSkeleton>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        updateNode(
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            nodeId: string,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            nodeType: string,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            nodeData: NodeSkeleton,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        ): Promise<NodeSkeleton>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    }
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Index

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Methods

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    createNode +Node | Frodo Library - v4.0.0-11
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Frodo Library - v4.0.0-11
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Type Alias Node

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      type Node = {
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          createNode(
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              nodeType: string,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              nodeData: NodeSkeleton,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          ): Promise<NodeSkeleton>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          deleteCustomNode(
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              nodeId?: string,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              nodeName?: string,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          ): Promise<CustomNodeSkeleton>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          deleteCustomNodes(
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              resultCallback?: ResultCallback<CustomNodeSkeleton>,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          ): Promise<CustomNodeSkeleton[]>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          deleteNode(nodeId: string, nodeType: string): Promise<NodeSkeleton>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          exportCustomNode(
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              nodeId?: string,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              nodeName?: string,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              options?: CustomNodeExportOptions,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          ): Promise<CustomNodeExportInterface>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          exportCustomNodes(
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              options?: CustomNodeExportOptions,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          ): Promise<CustomNodeExportInterface>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          exportNodes(): Promise<NodeExportInterface>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          findOrphanedNodes(): Promise<NodeSkeleton[]>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          getCustomNodeUsage(nodeId: string): Promise<CustomNodeUsage>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          getNodeClassification(nodeType: string): NodeClassificationType[];
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          importCustomNodes(
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              nodeId: string,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              nodeName: string,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              importData: CustomNodeExportInterface,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              options?: CustomNodeImportOptions,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              resultCallback?: ResultCallback<CustomNodeSkeleton>,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          ): Promise<CustomNodeSkeleton[]>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          isCloudExcludedNode(nodeType: string): boolean;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          isCloudOnlyNode(nodeType: string): boolean;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          isCustomNode(nodeType: string): boolean;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          isDeprecatedNode(nodeType: string): boolean;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          isPremiumNode(nodeType: string): boolean;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          readCustomNode(
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              nodeId?: string,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              nodeName?: string,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          ): Promise<CustomNodeSkeleton>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          readCustomNodes(): Promise<CustomNodeSkeleton[]>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          readNode(nodeId: string, nodeType: string): Promise<NodeSkeleton>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          readNodes(): Promise<NodeSkeleton[]>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          readNodesByType(nodeType: string): Promise<NodeSkeleton[]>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          readNodeTypes(): Promise<any>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          removeOrphanedNodes(orphanedNodes: NodeSkeleton[]): Promise<NodeSkeleton[]>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          updateCustomNode(
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              nodeId: string,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              nodeData: CustomNodeSkeleton,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          ): Promise<CustomNodeSkeleton>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          updateNode(
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              nodeId: string,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              nodeType: string,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              nodeData: NodeSkeleton,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          ): Promise<NodeSkeleton>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      }
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Index

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Methods

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • nodeType: string

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        node type

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • nodeData: NodeSkeleton

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        node object

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Returns Promise<NodeSkeleton>

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      a promise that resolves to an object containing a node object

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • Delete custom node. Either ID or name must be provided.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • Delete custom node. Either ID or name must be provided.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • OptionalnodeId: string

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          ID or service name of custom node. Takes priority over node display name if both are provided.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • OptionalnodeName: string

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Display name of custom node.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Returns Promise<CustomNodeSkeleton>

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        promise that resolves to a custom node object

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • Delete node by uuid and type

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • nodeId: string

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          node uuid

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • nodeType: string

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          node type

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Returns Promise<NodeSkeleton>

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        a promise that resolves to an object containing a node object

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • Export custom node. Either ID or name must be provided.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • OptionalnodeId: string

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          ID or service name of custom node. Takes priority over node display name if both are provided.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • OptionalnodeName: string

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Display name of custom node.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • Optionaloptions: CustomNodeExportOptions

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Custom node export options

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Returns Promise<CustomNodeExportInterface>

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        a promise that resolves to a custom node export object

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • Find all node configuration objects that are no longer referenced by any tree

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • Find all node configuration objects that are no longer referenced by any tree

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Returns Promise<NodeSkeleton[]>

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        a promise that resolves to an array of orphaned nodes

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • Get custom node usage by ID

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • nodeId: string

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          ID or service name of the custom node

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Returns Promise<CustomNodeUsage>

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        a promise that resolves to an object containing a custom node usage object

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • Get a node's classifications, which can be one or multiple of:

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • standard: can run on any instance of a ForgeRock platform
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • cloud: utilize nodes, which are exclusively available in the ForgeRock Identity Cloud
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • @@ -61,55 +61,55 @@

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • nodeType: string

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Node type

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Returns NodeClassificationType[]

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        an array of one or multiple classifications

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • Analyze if a node type is a cloud-excluded node. Cloud excluded nodes are OOTB nodes in self-hosted AM deployments but have been excluded in cloud.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • Analyze if a node type is a cloud-excluded node. Cloud excluded nodes are OOTB nodes in self-hosted AM deployments but have been excluded in cloud.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • nodeType: string

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          node type.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Returns boolean

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        True if node type is cloud-excluded, false otherwise.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • Analyze if a node type is a cloud-only node.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • Analyze if a node type is a cloud-only node.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • nodeType: string

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Node type

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Returns boolean

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        True if the node type is cloud-only, false otherwise.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • Analyze if a node is custom.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • Analyze if a node is custom.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • nodeType: string

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Node type

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Returns boolean

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        True if the node type is custom, false otherwise.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • Analyze if a node type has been deprecated

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • Analyze if a node type has been deprecated

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • nodeType: string

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          node type.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Returns boolean

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        True if node type is deprecated, false otherwise.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • Analyze if a node type is premium.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • Analyze if a node type is premium.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • nodeType: string

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Node type

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Returns boolean

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        True if the node type is premium, false otherwise.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • Read custom node. Either ID or name must be provided.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • OptionalnodeId: string

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          ID or service name of custom node. Takes priority over node display name if both are provided.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • OptionalnodeName: string

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Display name of custom node.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Returns Promise<CustomNodeSkeleton>

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        a promise that resolves to a custom node object

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • Read node by uuid and type

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • nodeId: string

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          node uuid

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • nodeType: string

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          node type

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Returns Promise<NodeSkeleton>

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        a promise that resolves to a node object

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • Read all nodes by type

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • nodeType: string

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          node type

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Returns Promise<NodeSkeleton[]>

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        a promise that resolves to an object containing an array of node objects of the requested type

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • Read all node types

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Returns Promise<any>

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        a promise that resolves to an array of node type objects

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • Remove orphaned nodes

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • orphanedNodes: NodeSkeleton[]

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Pass in an array of orphaned node configuration objects to remove

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Returns Promise<NodeSkeleton[]>

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        a promise that resolves to an array nodes that encountered errors deleting

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • Update or create node by uuid and type

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • nodeId: string

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          node uuid

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • nodeType: string

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          node type

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • nodeData: NodeSkeleton

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          node object

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Returns Promise<NodeSkeleton>

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        a promise that resolves to an object containing a node object

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      diff --git a/docs/types/Reference.NodeClassificationType.html b/docs/types/Reference.NodeClassificationType.html index 2244e529e..a8d322328 100644 --- a/docs/types/Reference.NodeClassificationType.html +++ b/docs/types/Reference.NodeClassificationType.html @@ -1 +1 @@ -NodeClassificationType | Frodo Library - v4.0.0-10
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Frodo Library - v4.0.0-10
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Type Alias NodeClassificationType

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        NodeClassificationType:
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            | "standard"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            | "custom"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            | "cloud"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            | "excluded"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            | "premium"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            | "deprecated"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        +NodeClassificationType | Frodo Library - v4.0.0-11
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Frodo Library - v4.0.0-11
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Type Alias NodeClassificationType

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          NodeClassificationType:
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              | "standard"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              | "custom"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              | "cloud"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              | "excluded"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              | "premium"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              | "deprecated"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          diff --git a/docs/types/Reference.NodeSkeleton.html b/docs/types/Reference.NodeSkeleton.html index 3ea666e51..4230ba4f3 100644 --- a/docs/types/Reference.NodeSkeleton.html +++ b/docs/types/Reference.NodeSkeleton.html @@ -1 +1 @@ -NodeSkeleton | Frodo Library - v4.0.0-10
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Frodo Library - v4.0.0-10
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Type Alias NodeSkeleton

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            NodeSkeleton: AmConfigEntityInterface & {
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                emailTemplateName?: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                filteredProviders?: string[];
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                identityResource?: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                nodes?: InnerNodeRefSkeletonInterface[];
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                script?: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                tree?: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                useFilterScript?: boolean;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                useScript?: boolean;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            }
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            +NodeSkeleton | Frodo Library - v4.0.0-11
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Frodo Library - v4.0.0-11
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Type Alias NodeSkeleton

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              NodeSkeleton: AmConfigEntityInterface & {
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  emailTemplateName?: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  filteredProviders?: string[];
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  identityResource?: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  nodes?: InnerNodeRefSkeletonInterface[];
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  script?: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  tree?: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  useFilterScript?: boolean;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  useScript?: boolean;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              }
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              diff --git a/docs/types/Reference.OAuth2Client.html b/docs/types/Reference.OAuth2Client.html index 21427a11a..5d84c4975 100644 --- a/docs/types/Reference.OAuth2Client.html +++ b/docs/types/Reference.OAuth2Client.html @@ -1,4 +1,4 @@ -OAuth2Client | Frodo Library - v4.0.0-10
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Frodo Library - v4.0.0-10
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Type Alias OAuth2Client

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                type OAuth2Client = {
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    createOAuth2Client(
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        clientId: string,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        clientData: OAuth2ClientSkeleton,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    ): Promise<OAuth2ClientSkeleton>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    createOAuth2ClientExportTemplate(): OAuth2ClientExportInterface;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    deleteOAuth2Client(clientId: string): Promise<OAuth2ClientSkeleton>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    deleteOAuth2Clients(): Promise<OAuth2ClientSkeleton[]>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    exportOAuth2Client(
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        clientId: string,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        options?: OAuth2ClientExportOptions,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    ): Promise<OAuth2ClientExportInterface>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    exportOAuth2Clients(
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        options?: OAuth2ClientExportOptions,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    ): Promise<OAuth2ClientExportInterface>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    getOAuth2Client(clientId: string): Promise<OAuth2ClientSkeleton>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    getOAuth2Clients(): Promise<OAuth2ClientSkeleton[]>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    importFirstOAuth2Client(
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        importData: OAuth2ClientExportInterface,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        options?: OAuth2ClientImportOptions,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    ): Promise<OAuth2ClientSkeleton>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    importOAuth2Client(
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        clientId: string,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        importData: OAuth2ClientExportInterface,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        options?: OAuth2ClientImportOptions,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    ): Promise<OAuth2ClientSkeleton>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    importOAuth2Clients(
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        importData: OAuth2ClientExportInterface,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        options?: OAuth2ClientImportOptions,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    ): Promise<OAuth2ClientSkeleton[]>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    putOAuth2Client(
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        clientId: string,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        clientData: OAuth2ClientSkeleton,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    ): Promise<OAuth2ClientSkeleton>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    readOAuth2Client(clientId: string): Promise<OAuth2ClientSkeleton>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    readOAuth2Clients(): Promise<OAuth2ClientSkeleton[]>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    updateOAuth2Client(
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        clientId: string,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        clientData: OAuth2ClientSkeleton,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    ): Promise<OAuth2ClientSkeleton>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                }
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Index

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Methods

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                createOAuth2Client +OAuth2Client | Frodo Library - v4.0.0-11
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Frodo Library - v4.0.0-11
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Type Alias OAuth2Client

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  type OAuth2Client = {
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      createOAuth2Client(
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          clientId: string,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          clientData: OAuth2ClientSkeleton,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      ): Promise<OAuth2ClientSkeleton>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      createOAuth2ClientExportTemplate(): OAuth2ClientExportInterface;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      deleteOAuth2Client(clientId: string): Promise<OAuth2ClientSkeleton>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      deleteOAuth2Clients(): Promise<OAuth2ClientSkeleton[]>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      exportOAuth2Client(
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          clientId: string,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          options?: OAuth2ClientExportOptions,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      ): Promise<OAuth2ClientExportInterface>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      exportOAuth2Clients(
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          options?: OAuth2ClientExportOptions,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      ): Promise<OAuth2ClientExportInterface>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      getOAuth2Client(clientId: string): Promise<OAuth2ClientSkeleton>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      getOAuth2Clients(): Promise<OAuth2ClientSkeleton[]>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      importFirstOAuth2Client(
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          importData: OAuth2ClientExportInterface,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          options?: OAuth2ClientImportOptions,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      ): Promise<OAuth2ClientSkeleton>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      importOAuth2Client(
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          clientId: string,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          importData: OAuth2ClientExportInterface,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          options?: OAuth2ClientImportOptions,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      ): Promise<OAuth2ClientSkeleton>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      importOAuth2Clients(
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          importData: OAuth2ClientExportInterface,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          options?: OAuth2ClientImportOptions,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      ): Promise<OAuth2ClientSkeleton[]>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      putOAuth2Client(
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          clientId: string,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          clientData: OAuth2ClientSkeleton,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      ): Promise<OAuth2ClientSkeleton>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      readOAuth2Client(clientId: string): Promise<OAuth2ClientSkeleton>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      readOAuth2Clients(): Promise<OAuth2ClientSkeleton[]>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      updateOAuth2Client(
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          clientId: string,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          clientData: OAuth2ClientSkeleton,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      ): Promise<OAuth2ClientSkeleton>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  }
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Index

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Methods

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Returns Promise<OAuth2ClientSkeleton>

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  a promise that resolves to an oauth2client object

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Deprecated

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Deprecated

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  diff --git a/docs/types/Reference.OAuth2ClientSkeleton.html b/docs/types/Reference.OAuth2ClientSkeleton.html index 25ba9325b..8e7ea87c3 100644 --- a/docs/types/Reference.OAuth2ClientSkeleton.html +++ b/docs/types/Reference.OAuth2ClientSkeleton.html @@ -1 +1 @@ -OAuth2ClientSkeleton | Frodo Library - v4.0.0-10
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Frodo Library - v4.0.0-10
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Type Alias OAuth2ClientSkeleton

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    OAuth2ClientSkeleton: AmConfigEntityInterface & {
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        advancedOAuth2ClientConfig?: {
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            descriptions: { inherited: boolean; value: string[] };
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            grantTypes?: Readable<string[]> | Writable<string[]>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            isConsentImplied?: Readable<boolean> | Writable<boolean>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            responseTypes?: Readable<string[]> | Writable<string[]>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            tokenEndpointAuthMethod?: Readable<string> | Writable<string>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            [k: string]: string | number | boolean | object | string[];
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        };
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        coreOAuth2ClientConfig?: {
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            accessTokenLifetime?: Readable<number>
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            | Writable<number>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            clientName?: Readable<string[]> | Writable<string[]>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            clientType?: Readable<string> | Writable<string>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            defaultScopes?: {
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                value: string[];
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                [k: string]: string | number | boolean | object | string[];
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            };
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            scopes?: Readable<string[]>
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            | Writable<string[]>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            userpassword?: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            [k: string]: string | number | boolean | object | string[];
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        };
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        coreOpenIDClientConfig?: {
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            [k: string]: string
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            | number
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            | boolean
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            | object
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            | string[];
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        };
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        coreUmaClientConfig?: {
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            [k: string]: string
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            | number
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            | boolean
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            | object
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            | string[];
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        };
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        overrideOAuth2ClientConfig?: {
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            [k: string]: string
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            | number
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            | boolean
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            | object
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            | string[];
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        };
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        signEncOAuth2ClientConfig?: {
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            jwkSet?: Readable<string>
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            | Writable<string>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            publicKeyLocation?: Readable<string> | Writable<string>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            [k: string]: string | number | boolean | object | string[];
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        };
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    }
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    +OAuth2ClientSkeleton | Frodo Library - v4.0.0-11
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Frodo Library - v4.0.0-11
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Type Alias OAuth2ClientSkeleton

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      OAuth2ClientSkeleton: AmConfigEntityInterface & {
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          advancedOAuth2ClientConfig?: {
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              descriptions: { inherited: boolean; value: string[] };
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              grantTypes?: Readable<string[]> | Writable<string[]>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              isConsentImplied?: Readable<boolean> | Writable<boolean>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              responseTypes?: Readable<string[]> | Writable<string[]>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              tokenEndpointAuthMethod?: Readable<string> | Writable<string>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              [k: string]: string | number | boolean | object | string[];
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          };
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          coreOAuth2ClientConfig?: {
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              accessTokenLifetime?: Readable<number>
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              | Writable<number>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              clientName?: Readable<string[]> | Writable<string[]>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              clientType?: Readable<string> | Writable<string>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              defaultScopes?: {
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  value: string[];
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  [k: string]: string | number | boolean | object | string[];
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              };
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              scopes?: Readable<string[]>
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              | Writable<string[]>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              userpassword?: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              [k: string]: string | number | boolean | object | string[];
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          };
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          coreOpenIDClientConfig?: {
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              [k: string]: string
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              | number
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              | boolean
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              | object
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              | string[];
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          };
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          coreUmaClientConfig?: {
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              [k: string]: string
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              | number
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              | boolean
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              | object
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              | string[];
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          };
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          overrideOAuth2ClientConfig?: {
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              [k: string]: string
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              | number
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              | boolean
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              | object
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              | string[];
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          };
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          signEncOAuth2ClientConfig?: {
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              jwkSet?: Readable<string>
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              | Writable<string>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              publicKeyLocation?: Readable<string> | Writable<string>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              [k: string]: string | number | boolean | object | string[];
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          };
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      }
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      diff --git a/docs/types/Reference.OAuth2Oidc.html b/docs/types/Reference.OAuth2Oidc.html index d9d517b4f..e5f673016 100644 --- a/docs/types/Reference.OAuth2Oidc.html +++ b/docs/types/Reference.OAuth2Oidc.html @@ -1,6 +1,6 @@ -OAuth2Oidc | Frodo Library - v4.0.0-10
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Frodo Library - v4.0.0-10
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Type Alias OAuth2Oidc

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        type OAuth2Oidc = {
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            accessToken(
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                amBaseUrl: string,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                data: any,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                config: AxiosRequestConfig,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            ): Promise<AccessTokenMetaType>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            accessTokenRfc7523AuthZGrant(
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                clientId: string,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                jwt: string,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                scope: string[],
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                config?: AxiosRequestConfig,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            ): Promise<AccessTokenMetaType>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            authorize(
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                amBaseUrl: string,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                data: string,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                config: AxiosRequestConfig,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            ): Promise<AxiosResponse<any, any, {}>>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            clientCredentialsGrant(
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                amBaseUrl: string,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                clientId: string,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                clientSecret: string,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                scope: string,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            ): Promise<AccessTokenMetaType>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            getTokenInfo(
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                amBaseUrl: string,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                config: AxiosRequestConfig,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            ): Promise<TokenInfoResponseType>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        }
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Index

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Methods

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        accessToken +OAuth2Oidc | Frodo Library - v4.0.0-11
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Frodo Library - v4.0.0-11
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Type Alias OAuth2Oidc

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          type OAuth2Oidc = {
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              accessToken(
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  amBaseUrl: string,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  data: any,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  config: AxiosRequestConfig,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              ): Promise<AccessTokenMetaType>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              accessTokenRfc7523AuthZGrant(
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  clientId: string,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  jwt: string,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  scope: string[],
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  config?: AxiosRequestConfig,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              ): Promise<AccessTokenMetaType>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              authorize(
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  amBaseUrl: string,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  data: string,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  config: AxiosRequestConfig,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              ): Promise<AxiosResponse<any, any, {}>>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              clientCredentialsGrant(
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  amBaseUrl: string,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  clientId: string,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  clientSecret: string,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  scope: string,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              ): Promise<AccessTokenMetaType>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              getTokenInfo(
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  amBaseUrl: string,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  config: AxiosRequestConfig,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              ): Promise<TokenInfoResponseType>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          }
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Index

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Methods

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • clientId: string
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • jwt: string
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • scope: string[]
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • Optionalconfig: AxiosRequestConfig

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Returns Promise<AccessTokenMetaType>

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • amBaseUrl: string
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • data: string
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • config: AxiosRequestConfig

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Returns Promise<AxiosResponse<any, any, {}>>

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Methods

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • clientId: string
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • jwt: string
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • scope: string[]
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • Optionalconfig: AxiosRequestConfig

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Returns Promise<AccessTokenMetaType>

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • amBaseUrl: string
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • data: string
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • config: AxiosRequestConfig

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Returns Promise<AxiosResponse<any, any, {}>>

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          diff --git a/docs/types/Reference.OAuth2Provider.html b/docs/types/Reference.OAuth2Provider.html index 981dd0dbd..6d801fed9 100644 --- a/docs/types/Reference.OAuth2Provider.html +++ b/docs/types/Reference.OAuth2Provider.html @@ -1,4 +1,4 @@ -OAuth2Provider | Frodo Library - v4.0.0-10
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Frodo Library - v4.0.0-10
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Type Alias OAuth2Provider

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            type OAuth2Provider = {
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                createOAuth2Provider(
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    providerData?: OAuth2ProviderSkeleton,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                ): Promise<OAuth2ProviderSkeleton>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                deleteOAuth2Provider(): Promise<OAuth2ProviderSkeleton>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                getOAuth2Provider(): Promise<OAuth2ProviderSkeleton>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                readOAuth2Provider(): Promise<OAuth2ProviderSkeleton>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                updateOAuth2Provider(
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    providerData: OAuth2ProviderSkeleton,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                ): Promise<OAuth2ProviderSkeleton>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            }
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Index

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Methods

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            createOAuth2Provider +OAuth2Provider | Frodo Library - v4.0.0-11
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Frodo Library - v4.0.0-11
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Type Alias OAuth2Provider

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              type OAuth2Provider = {
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  createOAuth2Provider(
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      providerData?: OAuth2ProviderSkeleton,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  ): Promise<OAuth2ProviderSkeleton>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  deleteOAuth2Provider(): Promise<OAuth2ProviderSkeleton>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  getOAuth2Provider(): Promise<OAuth2ProviderSkeleton>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  readOAuth2Provider(): Promise<OAuth2ProviderSkeleton>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  updateOAuth2Provider(
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      providerData: OAuth2ProviderSkeleton,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  ): Promise<OAuth2ProviderSkeleton>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              }
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Index

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Methods

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Deprecated

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Deprecated

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              diff --git a/docs/types/Reference.OAuth2ProviderSkeleton.html b/docs/types/Reference.OAuth2ProviderSkeleton.html index 6fb6deb75..e0605a24f 100644 --- a/docs/types/Reference.OAuth2ProviderSkeleton.html +++ b/docs/types/Reference.OAuth2ProviderSkeleton.html @@ -1 +1 @@ -OAuth2ProviderSkeleton | Frodo Library - v4.0.0-10
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Frodo Library - v4.0.0-10
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Type Alias OAuth2ProviderSkeleton

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                OAuth2ProviderSkeleton: AmConfigEntityInterface & {
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    advancedOAuth2Config?: {
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        allowClientCredentialsInTokenRequestQueryParameters?: boolean;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        allowedAudienceValues?: string[];
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        authenticationAttributes?: string[];
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        codeVerifierEnforced?: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        defaultScopes?: string[];
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        displayNameAttribute?: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        expClaimRequiredInRequestObject?: boolean;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        grantTypes?: string[];
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        hashSalt?: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        macaroonTokenFormat?: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        maxAgeOfRequestObjectNbfClaim?: number;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        maxDifferenceBetweenRequestObjectNbfAndExp?: number;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        moduleMessageEnabledInPasswordGrant?: boolean;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        nbfClaimRequiredInRequestObject?: boolean;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        parRequestUriLifetime?: number;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        passwordGrantAuthService?: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        persistentClaims?: string[];
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        refreshTokenGracePeriod?: number;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        requestObjectProcessing?: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        requirePushedAuthorizationRequests?: boolean;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        responseTypeClasses?: string[];
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        supportedScopes?: string[];
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        supportedSubjectTypes?: string[];
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        tlsCertificateBoundAccessTokensEnabled?: boolean;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        tlsCertificateRevocationCheckingEnabled?: boolean;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        tlsClientCertificateHeaderFormat?: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        tokenCompressionEnabled?: boolean;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        tokenEncryptionEnabled?: boolean;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        tokenExchangeClasses?: string[];
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        tokenSigningAlgorithm?: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        tokenValidatorClasses?: string[];
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        [k: string]: string | number | boolean | object | string[];
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    };
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    advancedOIDCConfig: {
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        alwaysAddClaimsToToken?: boolean;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        amrMappings?: any;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        authorisedIdmDelegationClients?: string[];
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        authorisedOpenIdConnectSSOClients?: string[];
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        claimsParameterSupported?: boolean;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        defaultACR?: string[];
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        idTokenInfoClientAuthenticationEnabled?: boolean;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        includeAllKtyAlgCombinationsInJwksUri?: boolean;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        loaMapping?: any;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        storeOpsTokens?: boolean;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        supportedAuthorizationResponseEncryptionAlgorithms?: string[];
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        supportedAuthorizationResponseEncryptionEnc?: string[];
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        supportedAuthorizationResponseSigningAlgorithms?: string[];
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        supportedRequestParameterEncryptionAlgorithms?: string[];
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        supportedRequestParameterEncryptionEnc?: string[];
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        supportedRequestParameterSigningAlgorithms?: string[];
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        supportedTokenEndpointAuthenticationSigningAlgorithms?: string[];
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        supportedTokenIntrospectionResponseEncryptionAlgorithms?: string[];
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        supportedTokenIntrospectionResponseEncryptionEnc?: string[];
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        supportedTokenIntrospectionResponseSigningAlgorithms?: string[];
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        supportedUserInfoEncryptionAlgorithms?: string[];
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        supportedUserInfoEncryptionEnc?: string[];
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        supportedUserInfoSigningAlgorithms?: string[];
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        useForceAuthnForMaxAge?: boolean;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        useForceAuthnForPromptLogin?: boolean;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        [k: string]: string
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        | number
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        | boolean
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        | object
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        | string[];
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    };
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    cibaConfig?: {
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        cibaAuthReqIdLifetime: number;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        cibaMinimumPollingInterval: number;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        supportedCibaSigningAlgorithms: string[];
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        [k: string]: string
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        | number
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        | boolean
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        | object
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        | string[];
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    };
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    clientDynamicRegistrationConfig?: {
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        allowDynamicRegistration: boolean;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        dynamicClientRegistrationScope: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        dynamicClientRegistrationSoftwareStatementRequired: boolean;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        generateRegistrationAccessTokens: boolean;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        requiredSoftwareStatementAttestedAttributes: string[];
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        [k: string]: string
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        | number
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        | boolean
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        | object
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        | string[];
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    };
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    consent?: {
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        clientsCanSkipConsent: boolean;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        enableRemoteConsent: boolean;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        supportedRcsRequestEncryptionAlgorithms: string[];
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        supportedRcsRequestEncryptionMethods: string[];
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        supportedRcsRequestSigningAlgorithms: string[];
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        supportedRcsResponseEncryptionAlgorithms: string[];
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        supportedRcsResponseEncryptionMethods: string[];
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        supportedRcsResponseSigningAlgorithms: string[];
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        [k: string]: string
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        | number
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        | boolean
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        | object
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        | string[];
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    };
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    coreOAuth2Config?: {
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        accessTokenLifetime: number;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        accessTokenMayActScript: "[Empty]"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        | string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        codeLifetime: number;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        issueRefreshToken: boolean;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        issueRefreshTokenOnRefreshedToken: boolean;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        macaroonTokensEnabled: boolean;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        oidcMayActScript: "[Empty]" | string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        refreshTokenLifetime: number;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        scopesPolicySet: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        statelessTokensEnabled: boolean;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        usePolicyEngineForScope: boolean;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        [k: string]: string | number | boolean | object | string[];
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    };
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    coreOIDCConfig?: {
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        jwtTokenLifetime: number;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        oidcDiscoveryEndpointEnabled: boolean;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        overrideableOIDCClaims: string[];
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        supportedClaims: string[];
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        supportedIDTokenEncryptionAlgorithms: string[];
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        supportedIDTokenEncryptionMethods: string[];
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        supportedIDTokenSigningAlgorithms: string[];
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        [k: string]: string
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        | number
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        | boolean
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        | object
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        | string[];
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    };
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    deviceCodeConfig?: {
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        deviceCodeLifetime: number;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        devicePollInterval: number;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        deviceUserCodeCharacterSet: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        deviceUserCodeLength: number;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        [k: string]: string
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        | number
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        | boolean
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        | object
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        | string[];
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    };
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    pluginsConfig?: {
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        accessTokenEnricherClass?: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        accessTokenModificationPluginType?: "JAVA"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        | "SCRIPTED";
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        accessTokenModificationScript?: "[Empty]" | string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        accessTokenModifierClass?: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        authorizeEndpointDataProviderClass?: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        authorizeEndpointDataProviderPluginType?: "JAVA" | "SCRIPTED";
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        authorizeEndpointDataProviderScript?: "[Empty]" | string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        evaluateScopeClass?: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        evaluateScopePluginType?: "JAVA" | "SCRIPTED";
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        evaluateScopeScript?: "[Empty]" | string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        oidcClaimsClass?: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        oidcClaimsPluginType?: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        oidcClaimsScript?: "[Empty]" | string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        userCodeGeneratorClass?: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        validateScopeClass?: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        validateScopePluginType?: "JAVA" | "SCRIPTED";
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        validateScopeScript?: "[Empty]" | string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        [k: string]: string | number | boolean | object | string[];
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    };
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    [k: string]: string
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    | number
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    | boolean
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    | object
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    | string[];
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                }
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                +OAuth2ProviderSkeleton | Frodo Library - v4.0.0-11
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Frodo Library - v4.0.0-11
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Type Alias OAuth2ProviderSkeleton

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  OAuth2ProviderSkeleton: AmConfigEntityInterface & {
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      advancedOAuth2Config?: {
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          allowClientCredentialsInTokenRequestQueryParameters?: boolean;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          allowedAudienceValues?: string[];
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          authenticationAttributes?: string[];
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          codeVerifierEnforced?: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          defaultScopes?: string[];
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          displayNameAttribute?: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          expClaimRequiredInRequestObject?: boolean;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          grantTypes?: string[];
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          hashSalt?: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          macaroonTokenFormat?: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          maxAgeOfRequestObjectNbfClaim?: number;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          maxDifferenceBetweenRequestObjectNbfAndExp?: number;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          moduleMessageEnabledInPasswordGrant?: boolean;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          nbfClaimRequiredInRequestObject?: boolean;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          parRequestUriLifetime?: number;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          passwordGrantAuthService?: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          persistentClaims?: string[];
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          refreshTokenGracePeriod?: number;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          requestObjectProcessing?: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          requirePushedAuthorizationRequests?: boolean;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          responseTypeClasses?: string[];
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          supportedScopes?: string[];
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          supportedSubjectTypes?: string[];
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          tlsCertificateBoundAccessTokensEnabled?: boolean;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          tlsCertificateRevocationCheckingEnabled?: boolean;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          tlsClientCertificateHeaderFormat?: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          tokenCompressionEnabled?: boolean;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          tokenEncryptionEnabled?: boolean;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          tokenExchangeClasses?: string[];
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          tokenSigningAlgorithm?: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          tokenValidatorClasses?: string[];
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          [k: string]: string | number | boolean | object | string[];
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      };
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      advancedOIDCConfig: {
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          alwaysAddClaimsToToken?: boolean;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          amrMappings?: any;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          authorisedIdmDelegationClients?: string[];
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          authorisedOpenIdConnectSSOClients?: string[];
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          claimsParameterSupported?: boolean;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          defaultACR?: string[];
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          idTokenInfoClientAuthenticationEnabled?: boolean;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          includeAllKtyAlgCombinationsInJwksUri?: boolean;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          loaMapping?: any;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          storeOpsTokens?: boolean;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          supportedAuthorizationResponseEncryptionAlgorithms?: string[];
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          supportedAuthorizationResponseEncryptionEnc?: string[];
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          supportedAuthorizationResponseSigningAlgorithms?: string[];
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          supportedRequestParameterEncryptionAlgorithms?: string[];
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          supportedRequestParameterEncryptionEnc?: string[];
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          supportedRequestParameterSigningAlgorithms?: string[];
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          supportedTokenEndpointAuthenticationSigningAlgorithms?: string[];
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          supportedTokenIntrospectionResponseEncryptionAlgorithms?: string[];
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          supportedTokenIntrospectionResponseEncryptionEnc?: string[];
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          supportedTokenIntrospectionResponseSigningAlgorithms?: string[];
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          supportedUserInfoEncryptionAlgorithms?: string[];
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          supportedUserInfoEncryptionEnc?: string[];
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          supportedUserInfoSigningAlgorithms?: string[];
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          useForceAuthnForMaxAge?: boolean;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          useForceAuthnForPromptLogin?: boolean;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          [k: string]: string
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          | number
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          | boolean
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          | object
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          | string[];
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      };
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      cibaConfig?: {
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          cibaAuthReqIdLifetime: number;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          cibaMinimumPollingInterval: number;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          supportedCibaSigningAlgorithms: string[];
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          [k: string]: string
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          | number
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          | boolean
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          | object
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          | string[];
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      };
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      clientDynamicRegistrationConfig?: {
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          allowDynamicRegistration: boolean;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          dynamicClientRegistrationScope: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          dynamicClientRegistrationSoftwareStatementRequired: boolean;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          generateRegistrationAccessTokens: boolean;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          requiredSoftwareStatementAttestedAttributes: string[];
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          [k: string]: string
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          | number
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          | boolean
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          | object
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          | string[];
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      };
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      consent?: {
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          clientsCanSkipConsent: boolean;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          enableRemoteConsent: boolean;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          supportedRcsRequestEncryptionAlgorithms: string[];
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          supportedRcsRequestEncryptionMethods: string[];
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          supportedRcsRequestSigningAlgorithms: string[];
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          supportedRcsResponseEncryptionAlgorithms: string[];
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          supportedRcsResponseEncryptionMethods: string[];
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          supportedRcsResponseSigningAlgorithms: string[];
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          [k: string]: string
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          | number
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          | boolean
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          | object
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          | string[];
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      };
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      coreOAuth2Config?: {
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          accessTokenLifetime: number;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          accessTokenMayActScript: "[Empty]"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          | string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          codeLifetime: number;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          issueRefreshToken: boolean;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          issueRefreshTokenOnRefreshedToken: boolean;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          macaroonTokensEnabled: boolean;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          oidcMayActScript: "[Empty]" | string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          refreshTokenLifetime: number;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          scopesPolicySet: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          statelessTokensEnabled: boolean;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          usePolicyEngineForScope: boolean;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          [k: string]: string | number | boolean | object | string[];
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      };
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      coreOIDCConfig?: {
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          jwtTokenLifetime: number;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          oidcDiscoveryEndpointEnabled: boolean;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          overrideableOIDCClaims: string[];
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          supportedClaims: string[];
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          supportedIDTokenEncryptionAlgorithms: string[];
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          supportedIDTokenEncryptionMethods: string[];
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          supportedIDTokenSigningAlgorithms: string[];
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          [k: string]: string
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          | number
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          | boolean
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          | object
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          | string[];
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      };
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      deviceCodeConfig?: {
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          deviceCodeLifetime: number;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          devicePollInterval: number;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          deviceUserCodeCharacterSet: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          deviceUserCodeLength: number;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          [k: string]: string
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          | number
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          | boolean
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          | object
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          | string[];
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      };
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      pluginsConfig?: {
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          accessTokenEnricherClass?: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          accessTokenModificationPluginType?: "JAVA"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          | "SCRIPTED";
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          accessTokenModificationScript?: "[Empty]" | string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          accessTokenModifierClass?: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          authorizeEndpointDataProviderClass?: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          authorizeEndpointDataProviderPluginType?: "JAVA" | "SCRIPTED";
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          authorizeEndpointDataProviderScript?: "[Empty]" | string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          evaluateScopeClass?: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          evaluateScopePluginType?: "JAVA" | "SCRIPTED";
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          evaluateScopeScript?: "[Empty]" | string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          oidcClaimsClass?: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          oidcClaimsPluginType?: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          oidcClaimsScript?: "[Empty]" | string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          userCodeGeneratorClass?: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          validateScopeClass?: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          validateScopePluginType?: "JAVA" | "SCRIPTED";
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          validateScopeScript?: "[Empty]" | string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          [k: string]: string | number | boolean | object | string[];
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      };
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      [k: string]: string
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      | number
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      | boolean
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      | object
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      | string[];
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  }
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  diff --git a/docs/types/Reference.OAuth2TrustedJwtIssuer.html b/docs/types/Reference.OAuth2TrustedJwtIssuer.html index bf32ed196..8d51fede8 100644 --- a/docs/types/Reference.OAuth2TrustedJwtIssuer.html +++ b/docs/types/Reference.OAuth2TrustedJwtIssuer.html @@ -1,4 +1,4 @@ -OAuth2TrustedJwtIssuer | Frodo Library - v4.0.0-10
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Frodo Library - v4.0.0-10
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Type Alias OAuth2TrustedJwtIssuer

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    type OAuth2TrustedJwtIssuer = {
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        createOAuth2TrustedJwtIssuer(
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            issuerId: string,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            issuerData: OAuth2TrustedJwtIssuerSkeleton,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        ): Promise<OAuth2TrustedJwtIssuerSkeleton>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        createOAuth2TrustedJwtIssuerExportTemplate(): OAuth2TrustedJwtIssuerExportInterface;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        deleteOAuth2TrustedJwtIssuer(
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            issuerId: string,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        ): Promise<OAuth2TrustedJwtIssuerSkeleton>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        deleteOAuth2TrustedJwtIssuers(): Promise<OAuth2TrustedJwtIssuerSkeleton[]>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        exportOAuth2TrustedJwtIssuer(
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            issuerId: string,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            options?: OAuth2TrustedJwtIssuerExportOptions,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        ): Promise<OAuth2TrustedJwtIssuerExportInterface>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        exportOAuth2TrustedJwtIssuers(
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            options?: OAuth2TrustedJwtIssuerExportOptions,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        ): Promise<OAuth2TrustedJwtIssuerExportInterface>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        getOAuth2TrustedJwtIssuer(
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            issuerId: string,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        ): Promise<OAuth2TrustedJwtIssuerSkeleton>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        getOAuth2TrustedJwtIssuers(): Promise<OAuth2TrustedJwtIssuerSkeleton[]>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        importFirstOAuth2TrustedJwtIssuer(
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            importData: OAuth2TrustedJwtIssuerExportInterface,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            options?: OAuth2TrustedJwtIssuerImportOptions,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        ): Promise<OAuth2TrustedJwtIssuerSkeleton>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        importOAuth2TrustedJwtIssuer(
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            issuerId: string,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            importData: OAuth2TrustedJwtIssuerExportInterface,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            options?: OAuth2TrustedJwtIssuerImportOptions,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        ): Promise<OAuth2TrustedJwtIssuerSkeleton>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        importOAuth2TrustedJwtIssuers(
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            importData: OAuth2TrustedJwtIssuerExportInterface,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            options?: OAuth2TrustedJwtIssuerImportOptions,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        ): Promise<OAuth2TrustedJwtIssuerSkeleton[]>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        putOAuth2TrustedJwtIssuer(
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            issuerId: string,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            issuerData: OAuth2TrustedJwtIssuerSkeleton,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        ): Promise<OAuth2TrustedJwtIssuerSkeleton>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        readOAuth2TrustedJwtIssuer(
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            issuerId: string,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        ): Promise<OAuth2TrustedJwtIssuerSkeleton>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        readOAuth2TrustedJwtIssuers(): Promise<OAuth2TrustedJwtIssuerSkeleton[]>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        updateOAuth2TrustedJwtIssuer(
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            issuerId: string,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            issuerData: OAuth2TrustedJwtIssuerSkeleton,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        ): Promise<OAuth2TrustedJwtIssuerSkeleton>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    }
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Index

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Methods

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    createOAuth2TrustedJwtIssuer +OAuth2TrustedJwtIssuer | Frodo Library - v4.0.0-11
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Frodo Library - v4.0.0-11
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Type Alias OAuth2TrustedJwtIssuer

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      type OAuth2TrustedJwtIssuer = {
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          createOAuth2TrustedJwtIssuer(
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              issuerId: string,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              issuerData: OAuth2TrustedJwtIssuerSkeleton,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          ): Promise<OAuth2TrustedJwtIssuerSkeleton>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          createOAuth2TrustedJwtIssuerExportTemplate(): OAuth2TrustedJwtIssuerExportInterface;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          deleteOAuth2TrustedJwtIssuer(
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              issuerId: string,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          ): Promise<OAuth2TrustedJwtIssuerSkeleton>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          deleteOAuth2TrustedJwtIssuers(): Promise<OAuth2TrustedJwtIssuerSkeleton[]>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          exportOAuth2TrustedJwtIssuer(
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              issuerId: string,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              options?: OAuth2TrustedJwtIssuerExportOptions,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          ): Promise<OAuth2TrustedJwtIssuerExportInterface>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          exportOAuth2TrustedJwtIssuers(
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              options?: OAuth2TrustedJwtIssuerExportOptions,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          ): Promise<OAuth2TrustedJwtIssuerExportInterface>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          getOAuth2TrustedJwtIssuer(
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              issuerId: string,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          ): Promise<OAuth2TrustedJwtIssuerSkeleton>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          getOAuth2TrustedJwtIssuers(): Promise<OAuth2TrustedJwtIssuerSkeleton[]>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          importFirstOAuth2TrustedJwtIssuer(
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              importData: OAuth2TrustedJwtIssuerExportInterface,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              options?: OAuth2TrustedJwtIssuerImportOptions,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          ): Promise<OAuth2TrustedJwtIssuerSkeleton>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          importOAuth2TrustedJwtIssuer(
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              issuerId: string,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              importData: OAuth2TrustedJwtIssuerExportInterface,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              options?: OAuth2TrustedJwtIssuerImportOptions,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          ): Promise<OAuth2TrustedJwtIssuerSkeleton>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          importOAuth2TrustedJwtIssuers(
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              importData: OAuth2TrustedJwtIssuerExportInterface,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              options?: OAuth2TrustedJwtIssuerImportOptions,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          ): Promise<OAuth2TrustedJwtIssuerSkeleton[]>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          putOAuth2TrustedJwtIssuer(
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              issuerId: string,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              issuerData: OAuth2TrustedJwtIssuerSkeleton,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          ): Promise<OAuth2TrustedJwtIssuerSkeleton>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          readOAuth2TrustedJwtIssuer(
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              issuerId: string,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          ): Promise<OAuth2TrustedJwtIssuerSkeleton>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          readOAuth2TrustedJwtIssuers(): Promise<OAuth2TrustedJwtIssuerSkeleton[]>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          updateOAuth2TrustedJwtIssuer(
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              issuerId: string,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              issuerData: OAuth2TrustedJwtIssuerSkeleton,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          ): Promise<OAuth2TrustedJwtIssuerSkeleton>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      }
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Index

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Methods

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Returns Promise<OAuth2TrustedJwtIssuerSkeleton>

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      a promise that resolves to an trusted jwt issuer object

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Deprecated

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Deprecated

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      diff --git a/docs/types/Reference.OAuth2TrustedJwtIssuerSkeleton.html b/docs/types/Reference.OAuth2TrustedJwtIssuerSkeleton.html index 8473f24ea..7c82f2758 100644 --- a/docs/types/Reference.OAuth2TrustedJwtIssuerSkeleton.html +++ b/docs/types/Reference.OAuth2TrustedJwtIssuerSkeleton.html @@ -1 +1 @@ -OAuth2TrustedJwtIssuerSkeleton | Frodo Library - v4.0.0-10
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Frodo Library - v4.0.0-10
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Type Alias OAuth2TrustedJwtIssuerSkeleton

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        OAuth2TrustedJwtIssuerSkeleton: IdObjectSkeletonInterface & {
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            _type: {
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                _id: "TrustedJwtIssuer";
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                collection: true;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                name: "OAuth2 Trusted JWT Issuer";
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            };
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            allowedSubjects?: Readable<string[]>
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            | Writable<string[]>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            consentedScopesClaim?: Readable<string> | Writable<string>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            issuer: Readable<string> | Writable<string>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            jwksCacheTimeout?: Readable<number> | Writable<number>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            jwkSet?: Readable<string> | Writable<string>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            jwkStoreCacheMissCacheTime?: Readable<number> | Writable<number>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            jwksUri?: Readable<string> | Writable<string>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            resourceOwnerIdentityClaim?: Readable<string> | Writable<string>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        }
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        +OAuth2TrustedJwtIssuerSkeleton | Frodo Library - v4.0.0-11
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Frodo Library - v4.0.0-11
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Type Alias OAuth2TrustedJwtIssuerSkeleton

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          OAuth2TrustedJwtIssuerSkeleton: IdObjectSkeletonInterface & {
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              _type: {
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  _id: "TrustedJwtIssuer";
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  collection: true;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  name: "OAuth2 Trusted JWT Issuer";
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              };
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              allowedSubjects?: Readable<string[]>
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              | Writable<string[]>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              consentedScopesClaim?: Readable<string> | Writable<string>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              issuer: Readable<string> | Writable<string>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              jwksCacheTimeout?: Readable<number> | Writable<number>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              jwkSet?: Readable<string> | Writable<string>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              jwkStoreCacheMissCacheTime?: Readable<number> | Writable<number>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              jwksUri?: Readable<string> | Writable<string>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              resourceOwnerIdentityClaim?: Readable<string> | Writable<string>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          }
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          diff --git a/docs/types/Reference.ObjectPropertyFlag.html b/docs/types/Reference.ObjectPropertyFlag.html index 5675e4010..1deb15574 100644 --- a/docs/types/Reference.ObjectPropertyFlag.html +++ b/docs/types/Reference.ObjectPropertyFlag.html @@ -1 +1 @@ -ObjectPropertyFlag | Frodo Library - v4.0.0-10
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Frodo Library - v4.0.0-10
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Type Alias ObjectPropertyFlag

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            ObjectPropertyFlag:
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                | "NOT_CREATABLE"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                | "NOT_READABLE"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                | "NOT_RETURNED_BY_DEFAULT"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                | "NOT_UPDATEABLE"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            +ObjectPropertyFlag | Frodo Library - v4.0.0-11
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Frodo Library - v4.0.0-11
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Type Alias ObjectPropertyFlag

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              ObjectPropertyFlag:
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  | "NOT_CREATABLE"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  | "NOT_READABLE"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  | "NOT_RETURNED_BY_DEFAULT"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  | "NOT_UPDATEABLE"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              diff --git a/docs/types/Reference.ObjectPropertyNativeType.html b/docs/types/Reference.ObjectPropertyNativeType.html index fe0cfd199..668f6cfe7 100644 --- a/docs/types/Reference.ObjectPropertyNativeType.html +++ b/docs/types/Reference.ObjectPropertyNativeType.html @@ -1 +1 @@ -ObjectPropertyNativeType | Frodo Library - v4.0.0-10
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Frodo Library - v4.0.0-10
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Type Alias ObjectPropertyNativeType

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                ObjectPropertyNativeType:
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    | "array"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    | "boolean"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    | "string"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    | "JAVA_TYPE_BIGDECIMAL"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    | "JAVA_TYPE_BIGINTEGER"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    | "JAVA_TYPE_BYTE"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    | "JAVA_TYPE_BYTE_ARRAY"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    | "JAVA_TYPE_CHAR"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    | "JAVA_TYPE_CHARACTER"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    | "JAVA_TYPE_DATE"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    | "JAVA_TYPE_DOUBLE"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    | "JAVA_TYPE_FILE"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    | "JAVA_TYPE_FLOAT"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    | "JAVA_TYPE_GUARDEDBYTEARRAY"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    | "JAVA_TYPE_GUARDEDSTRING"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    | "JAVA_TYPE_INT"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    | "JAVA_TYPE_INTEGER"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    | "JAVA_TYPE_LONG"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    | "JAVA_TYPE_OBJECT"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    | "JAVA_TYPE_PRIMITIVE_BOOLEAN"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    | "JAVA_TYPE_PRIMITIVE_BYTE"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    | "JAVA_TYPE_PRIMITIVE_DOUBLE"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    | "JAVA_TYPE_PRIMITIVE_FLOAT"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    | "JAVA_TYPE_PRIMITIVE_LONG"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    | "JAVA_TYPE_STRING"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                +ObjectPropertyNativeType | Frodo Library - v4.0.0-11
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Frodo Library - v4.0.0-11
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Type Alias ObjectPropertyNativeType

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  ObjectPropertyNativeType:
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      | "array"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      | "boolean"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      | "string"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      | "JAVA_TYPE_BIGDECIMAL"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      | "JAVA_TYPE_BIGINTEGER"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      | "JAVA_TYPE_BYTE"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      | "JAVA_TYPE_BYTE_ARRAY"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      | "JAVA_TYPE_CHAR"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      | "JAVA_TYPE_CHARACTER"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      | "JAVA_TYPE_DATE"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      | "JAVA_TYPE_DOUBLE"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      | "JAVA_TYPE_FILE"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      | "JAVA_TYPE_FLOAT"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      | "JAVA_TYPE_GUARDEDBYTEARRAY"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      | "JAVA_TYPE_GUARDEDSTRING"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      | "JAVA_TYPE_INT"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      | "JAVA_TYPE_INTEGER"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      | "JAVA_TYPE_LONG"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      | "JAVA_TYPE_OBJECT"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      | "JAVA_TYPE_PRIMITIVE_BOOLEAN"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      | "JAVA_TYPE_PRIMITIVE_BYTE"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      | "JAVA_TYPE_PRIMITIVE_DOUBLE"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      | "JAVA_TYPE_PRIMITIVE_FLOAT"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      | "JAVA_TYPE_PRIMITIVE_LONG"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      | "JAVA_TYPE_STRING"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  diff --git a/docs/types/Reference.ObjectPropertySkeleton.html b/docs/types/Reference.ObjectPropertySkeleton.html index 85bf231ef..e6f8d8d68 100644 --- a/docs/types/Reference.ObjectPropertySkeleton.html +++ b/docs/types/Reference.ObjectPropertySkeleton.html @@ -1,8 +1,8 @@ -ObjectPropertySkeleton | Frodo Library - v4.0.0-10
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Frodo Library - v4.0.0-10
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Type Alias ObjectPropertySkeleton

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    type ObjectPropertySkeleton = {
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        flags?: ObjectPropertyFlag[];
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        items?: { nativeType: ObjectPropertyNativeType; type: ObjectPropertyType };
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        nativeName: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        nativeType: ObjectPropertyNativeType;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        required?: boolean;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        runAsUser?: boolean;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        type: ObjectPropertyType;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    }
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Index

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Properties

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    flags? +ObjectPropertySkeleton | Frodo Library - v4.0.0-11
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Frodo Library - v4.0.0-11
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Type Alias ObjectPropertySkeleton

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      type ObjectPropertySkeleton = {
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          flags?: ObjectPropertyFlag[];
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          items?: { nativeType: ObjectPropertyNativeType; type: ObjectPropertyType };
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          nativeName: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          nativeType: ObjectPropertyNativeType;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          required?: boolean;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          runAsUser?: boolean;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          type: ObjectPropertyType;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      }
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Index

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Properties

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      items?: { nativeType: ObjectPropertyNativeType; type: ObjectPropertyType }
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      nativeName: string
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      required?: boolean
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      runAsUser?: boolean
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Properties

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      items?: { nativeType: ObjectPropertyNativeType; type: ObjectPropertyType }
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      nativeName: string
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      required?: boolean
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      runAsUser?: boolean
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      diff --git a/docs/types/Reference.ObjectPropertyType.html b/docs/types/Reference.ObjectPropertyType.html index 40277c8f2..0396e7ae2 100644 --- a/docs/types/Reference.ObjectPropertyType.html +++ b/docs/types/Reference.ObjectPropertyType.html @@ -1 +1 @@ -ObjectPropertyType | Frodo Library - v4.0.0-10
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Frodo Library - v4.0.0-10
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Type Alias ObjectPropertyType

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        ObjectPropertyType: "array" | "boolean" | "string"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        +ObjectPropertyType | Frodo Library - v4.0.0-11
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Frodo Library - v4.0.0-11
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Type Alias ObjectPropertyType

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          ObjectPropertyType: "array" | "boolean" | "string"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          diff --git a/docs/types/Reference.ObjectTypeSkeleton.html b/docs/types/Reference.ObjectTypeSkeleton.html index 9528ea0d1..4694bfd5d 100644 --- a/docs/types/Reference.ObjectTypeSkeleton.html +++ b/docs/types/Reference.ObjectTypeSkeleton.html @@ -1,6 +1,6 @@ -ObjectTypeSkeleton | Frodo Library - v4.0.0-10
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Frodo Library - v4.0.0-10
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Type Alias ObjectTypeSkeleton

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            type ObjectTypeSkeleton = {
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                $schema: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                id: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                nativeType: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                properties: Record<string, ObjectPropertySkeleton>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                type: "object";
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            }
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Index

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Properties

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            $schema +ObjectTypeSkeleton | Frodo Library - v4.0.0-11
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Frodo Library - v4.0.0-11
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Type Alias ObjectTypeSkeleton

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              type ObjectTypeSkeleton = {
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  $schema: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  id: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  nativeType: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  properties: Record<string, ObjectPropertySkeleton>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  type: "object";
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              }
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Index

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Properties

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              $schema: string
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              id: string
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              nativeType: string
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              properties: Record<string, ObjectPropertySkeleton>
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              type: "object"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Properties

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              $schema: string
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              id: string
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              nativeType: string
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              properties: Record<string, ObjectPropertySkeleton>
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              type: "object"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              diff --git a/docs/types/Reference.Organization.html b/docs/types/Reference.Organization.html index da345a779..465d407f3 100644 --- a/docs/types/Reference.Organization.html +++ b/docs/types/Reference.Organization.html @@ -1,14 +1,14 @@ -Organization | Frodo Library - v4.0.0-10
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Frodo Library - v4.0.0-10
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Type Alias Organization

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                type Organization = {
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    getOrganizations(): Promise<IdObjectSkeletonInterface[]>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    getRealmManagedOrganization(): string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    readOrganizations(): Promise<IdObjectSkeletonInterface[]>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                }
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Index

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Methods

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                getRealmManagedOrganization +Organization | Frodo Library - v4.0.0-11
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Frodo Library - v4.0.0-11
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Type Alias Organization

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  type Organization = {
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      getOrganizations(): Promise<IdObjectSkeletonInterface[]>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      getRealmManagedOrganization(): string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      readOrganizations(): Promise<IdObjectSkeletonInterface[]>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  }
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Index

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Methods

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • Get organization managed object type

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Returns string

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    organization managed object type in this realm

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Deprecated

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Deprecated

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  diff --git a/docs/types/Reference.PagedResult.html b/docs/types/Reference.PagedResult.html index c7c8f7099..7acbc011e 100644 --- a/docs/types/Reference.PagedResult.html +++ b/docs/types/Reference.PagedResult.html @@ -1,7 +1,7 @@ -PagedResult | Frodo Library - v4.0.0-10
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Frodo Library - v4.0.0-10
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Type Alias PagedResult<Type>

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    type PagedResult<Type> = {
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        pagedResultsCookie: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        remainingPagedResults: number;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        result: Type[];
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        resultCount: number;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        totalPagedResults: number;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        totalPagedResultsPolicy: "EXACT" | "NONE";
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    }

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Type Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • Type
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Index

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Properties

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    pagedResultsCookie +PagedResult | Frodo Library - v4.0.0-11
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Frodo Library - v4.0.0-11
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Type Alias PagedResult<Type>

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      type PagedResult<Type> = {
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          pagedResultsCookie: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          remainingPagedResults: number;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          result: Type[];
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          resultCount: number;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          totalPagedResults: number;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          totalPagedResultsPolicy: "EXACT" | "NONE";
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      }

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Type Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • Type
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Index

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Properties

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      pagedResultsCookie: string
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      remainingPagedResults: number
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      result: Type[]
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      resultCount: number
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      totalPagedResults: number
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      totalPagedResultsPolicy: "EXACT" | "NONE"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Properties

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      pagedResultsCookie: string
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      remainingPagedResults: number
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      result: Type[]
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      resultCount: number
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      totalPagedResults: number
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      totalPagedResultsPolicy: "EXACT" | "NONE"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      diff --git a/docs/types/Reference.PlatformInfo.html b/docs/types/Reference.PlatformInfo.html index 0a2318fd6..a5ea4798e 100644 --- a/docs/types/Reference.PlatformInfo.html +++ b/docs/types/Reference.PlatformInfo.html @@ -1 +1 @@ -PlatformInfo | Frodo Library - v4.0.0-10
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Frodo Library - v4.0.0-10
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Type Alias PlatformInfo

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        PlatformInfo: PlatformInfoInterface & Partial<EnvInfoInterface>
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        +PlatformInfo | Frodo Library - v4.0.0-11
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Frodo Library - v4.0.0-11
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Type Alias PlatformInfo

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          PlatformInfo: PlatformInfoInterface & Partial<EnvInfoInterface>
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          diff --git a/docs/types/Reference.Policy.html b/docs/types/Reference.Policy.html index 7c1247612..cc69506f2 100644 --- a/docs/types/Reference.Policy.html +++ b/docs/types/Reference.Policy.html @@ -1,4 +1,4 @@ -Policy | Frodo Library - v4.0.0-10
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Frodo Library - v4.0.0-10
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Type Alias Policy

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            type Policy = {
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                createPolicy(
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    policyId: string,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    policyData: PolicySkeleton,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                ): Promise<PolicySkeleton>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                createPolicyExportTemplate(): PolicyExportInterface;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                deletePolicy(policyId: string): Promise<any>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                exportPolicies(
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    options?: PolicyExportOptions,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                ): Promise<PolicyExportInterface>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                exportPoliciesByPolicySet(
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    policySetName: string,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    options?: PolicyExportOptions,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                ): Promise<PolicyExportInterface>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                exportPolicy(
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    policyId: string,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    options?: PolicyExportOptions,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                ): Promise<PolicyExportInterface>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                getPolicies(): Promise<PolicySkeleton[]>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                getPoliciesByPolicySet(policySetId: string): Promise<PolicySkeleton[]>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                getPolicy(policyId: string): Promise<PolicySkeleton>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                importFirstPolicy(
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    importData: PolicyExportInterface,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    options?: PolicyImportOptions,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                ): Promise<PolicySkeleton>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                importPolicies(
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    importData: PolicyExportInterface,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    options?: PolicyImportOptions,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                ): Promise<PolicySkeleton[]>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                importPolicy(
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    policyId: string,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    importData: PolicyExportInterface,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    options?: PolicyImportOptions,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                ): Promise<PolicySkeleton>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                putPolicy(
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    policyId: string,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    policyData: PolicySkeleton,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                ): Promise<PolicySkeleton>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                readPolicies(): Promise<PolicySkeleton[]>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                readPoliciesByPolicySet(policySetId: string): Promise<PolicySkeleton[]>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                readPolicy(policyId: string): Promise<PolicySkeleton>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                updatePolicy(
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    policyId: string,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    policyData: PolicySkeleton,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                ): Promise<PolicySkeleton>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            }
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Index

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Methods

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            createPolicy +Policy | Frodo Library - v4.0.0-11
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Frodo Library - v4.0.0-11
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Type Alias Policy

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              type Policy = {
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  createPolicy(
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      policyId: string,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      policyData: PolicySkeleton,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  ): Promise<PolicySkeleton>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  createPolicyExportTemplate(): PolicyExportInterface;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  deletePolicy(policyId: string): Promise<any>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  exportPolicies(
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      options?: PolicyExportOptions,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  ): Promise<PolicyExportInterface>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  exportPoliciesByPolicySet(
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      policySetName: string,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      options?: PolicyExportOptions,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  ): Promise<PolicyExportInterface>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  exportPolicy(
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      policyId: string,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      options?: PolicyExportOptions,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  ): Promise<PolicyExportInterface>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  getPolicies(): Promise<PolicySkeleton[]>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  getPoliciesByPolicySet(policySetId: string): Promise<PolicySkeleton[]>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  getPolicy(policyId: string): Promise<PolicySkeleton>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  importFirstPolicy(
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      importData: PolicyExportInterface,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      options?: PolicyImportOptions,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  ): Promise<PolicySkeleton>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  importPolicies(
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      importData: PolicyExportInterface,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      options?: PolicyImportOptions,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  ): Promise<PolicySkeleton[]>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  importPolicy(
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      policyId: string,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      importData: PolicyExportInterface,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      options?: PolicyImportOptions,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  ): Promise<PolicySkeleton>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  putPolicy(
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      policyId: string,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      policyData: PolicySkeleton,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  ): Promise<PolicySkeleton>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  readPolicies(): Promise<PolicySkeleton[]>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  readPoliciesByPolicySet(policySetId: string): Promise<PolicySkeleton[]>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  readPolicy(policyId: string): Promise<PolicySkeleton>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  updatePolicy(
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      policyId: string,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      policyData: PolicySkeleton,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  ): Promise<PolicySkeleton>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              }
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Index

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Methods

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • policyId: string

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                policy id/name

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • policyData: PolicySkeleton

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                policy object

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Returns Promise<PolicySkeleton>

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              promise resolving to a policy object

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • Delete policy

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • policyId: string

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  policy id/name

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Returns Promise<any>

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                promise resolving to a policy object

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • Get policies by policy set

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • policySetId: string

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  policy set id/name

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Returns Promise<PolicySkeleton[]>

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                a promise resolving to an array of policy objects

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Deprecated

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Deprecated

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • Get all policies

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Returns Promise<PolicySkeleton[]>

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                a promise that resolves to an array of policy set objects

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                since v2.0.0 use Agent.readPolicies | readPolicies instead

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                readPolicies(): Promise<PolicySkeleton[]>
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                 
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • Get policies by policy set

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • policySetId: string

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  policy set id/name

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Returns Promise<PolicySkeleton[]>

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                a promise resolving to an array of policy objects

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                since v2.0.0 use Agent.readPoliciesByPolicySet | readPoliciesByPolicySet instead

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                readPoliciesByPolicySet(policySetId: string): Promise<PolicySkeleton[]>
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                 
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              diff --git a/docs/types/Reference.PolicyCondition.html b/docs/types/Reference.PolicyCondition.html index f042de8e0..479663d82 100644 --- a/docs/types/Reference.PolicyCondition.html +++ b/docs/types/Reference.PolicyCondition.html @@ -1 +1 @@ -PolicyCondition | Frodo Library - v4.0.0-10
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Frodo Library - v4.0.0-10
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Type Alias PolicyCondition

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                PolicyCondition: NoIdObjectSkeletonInterface & {
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    condition?: PolicyCondition;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    conditions?: PolicyCondition[];
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    type: PolicyConditionType;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                }
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                +PolicyCondition | Frodo Library - v4.0.0-11
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Frodo Library - v4.0.0-11
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Type Alias PolicyCondition

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  PolicyCondition: NoIdObjectSkeletonInterface & {
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      condition?: PolicyCondition;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      conditions?: PolicyCondition[];
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      type: PolicyConditionType;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  }
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  diff --git a/docs/types/Reference.PolicyConditionType.html b/docs/types/Reference.PolicyConditionType.html index d23c100e7..fe4a39a2a 100644 --- a/docs/types/Reference.PolicyConditionType.html +++ b/docs/types/Reference.PolicyConditionType.html @@ -1 +1 @@ -PolicyConditionType | Frodo Library - v4.0.0-10
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Frodo Library - v4.0.0-10
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Type Alias PolicyConditionType

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    PolicyConditionType:
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        | "Script"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        | "AMIdentityMembership"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        | "IPv6"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        | "IPv4"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        | "SimpleTime"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        | "LEAuthLevel"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        | "LDAPFilter"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        | "AuthScheme"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        | "Session"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        | "AND"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        | "AuthenticateToRealm"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        | "ResourceEnvIP"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        | "Policy"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        | "OAuth2Scope"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        | "SessionProperty"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        | "OR"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        | "Transaction"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        | "NOT"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        | "AuthLevel"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        | "AuthenticateToService"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    +PolicyConditionType | Frodo Library - v4.0.0-11
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Frodo Library - v4.0.0-11
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Type Alias PolicyConditionType

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      PolicyConditionType:
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          | "Script"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          | "AMIdentityMembership"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          | "IPv6"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          | "IPv4"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          | "SimpleTime"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          | "LEAuthLevel"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          | "LDAPFilter"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          | "AuthScheme"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          | "Session"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          | "AND"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          | "AuthenticateToRealm"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          | "ResourceEnvIP"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          | "Policy"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          | "OAuth2Scope"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          | "SessionProperty"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          | "OR"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          | "Transaction"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          | "NOT"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          | "AuthLevel"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          | "AuthenticateToService"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      diff --git a/docs/types/Reference.PolicySet.html b/docs/types/Reference.PolicySet.html index b48509bfb..b66acefed 100644 --- a/docs/types/Reference.PolicySet.html +++ b/docs/types/Reference.PolicySet.html @@ -1,4 +1,4 @@ -PolicySet | Frodo Library - v4.0.0-10
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Frodo Library - v4.0.0-10
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Type Alias PolicySet

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        type PolicySet = {
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            createPolicySet(
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                policySetData: PolicySetSkeleton,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                policySetName?: string,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            ): Promise<PolicySetSkeleton>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            createPolicySetExportTemplate(): PolicySetExportInterface;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            deletePolicySet(policySetName: string): Promise<PolicySetSkeleton>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            exportPolicySet(
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                policySetName: string,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                options?: PolicySetExportOptions,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            ): Promise<PolicySetExportInterface>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            exportPolicySets(
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                options?: PolicySetExportOptions,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            ): Promise<PolicySetExportInterface>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            getPolicySet(policySetName: string): Promise<PolicySetSkeleton>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            getPolicySets(): Promise<PolicySetSkeleton[]>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            importFirstPolicySet(
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                importData: PolicySetExportInterface,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                options?: PolicySetImportOptions,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            ): Promise<any>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            importPolicySet(
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                policySetName: string,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                importData: PolicySetExportInterface,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                options?: PolicySetImportOptions,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            ): Promise<any>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            importPolicySets(
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                importData: PolicySetExportInterface,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                options?: PolicySetImportOptions,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            ): Promise<any[]>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            readPolicySet(policySetName: string): Promise<PolicySetSkeleton>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            readPolicySets(): Promise<PolicySetSkeleton[]>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            updatePolicySet(
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                policySetData: PolicySetSkeleton,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                policySetName?: string,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            ): Promise<PolicySetSkeleton>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        }
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Index

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Methods

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        createPolicySet +PolicySet | Frodo Library - v4.0.0-11
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Frodo Library - v4.0.0-11
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Type Alias PolicySet

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          type PolicySet = {
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              createPolicySet(
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  policySetData: PolicySetSkeleton,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  policySetName?: string,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              ): Promise<PolicySetSkeleton>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              createPolicySetExportTemplate(): PolicySetExportInterface;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              deletePolicySet(policySetName: string): Promise<PolicySetSkeleton>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              exportPolicySet(
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  policySetName: string,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  options?: PolicySetExportOptions,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              ): Promise<PolicySetExportInterface>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              exportPolicySets(
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  options?: PolicySetExportOptions,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              ): Promise<PolicySetExportInterface>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              getPolicySet(policySetName: string): Promise<PolicySetSkeleton>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              getPolicySets(): Promise<PolicySetSkeleton[]>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              importFirstPolicySet(
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  importData: PolicySetExportInterface,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  options?: PolicySetImportOptions,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              ): Promise<any>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              importPolicySet(
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  policySetName: string,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  importData: PolicySetExportInterface,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  options?: PolicySetImportOptions,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              ): Promise<any>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              importPolicySets(
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  importData: PolicySetExportInterface,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  options?: PolicySetImportOptions,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              ): Promise<any[]>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              readPolicySet(policySetName: string): Promise<PolicySetSkeleton>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              readPolicySets(): Promise<PolicySetSkeleton[]>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              updatePolicySet(
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  policySetData: PolicySetSkeleton,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  policySetName?: string,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              ): Promise<PolicySetSkeleton>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          }
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Index

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Methods

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Methods

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Returns Promise<any>

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Returns Promise<any>

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Deprecated

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Deprecated

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • Get policy set

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • policySetName: string

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              policy set name

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Returns Promise<PolicySetSkeleton>

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            a promise that resolves to a policy set object

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            since v2.0.0 use Policy.readPolicySet | readPolicySet instead

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            readPolicySet(policySetName: string): Promise<PolicySetSkeleton>
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                             
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • Get all policy sets

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Returns Promise<PolicySetSkeleton[]>

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            a promise that resolves to an array of policy set objects

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            since v2.0.0 use Policy.readPolicySets | readPolicySets instead

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            readPolicySets(): Promise<PolicySetSkeleton[]>
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                             
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          diff --git a/docs/types/Reference.PolicySetSkeleton.html b/docs/types/Reference.PolicySetSkeleton.html index 0a7351916..87088c6c9 100644 --- a/docs/types/Reference.PolicySetSkeleton.html +++ b/docs/types/Reference.PolicySetSkeleton.html @@ -1 +1 @@ -PolicySetSkeleton | Frodo Library - v4.0.0-10
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Frodo Library - v4.0.0-10
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Type Alias PolicySetSkeleton

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            PolicySetSkeleton: NoIdObjectSkeletonInterface & {
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                name: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                resourceTypeUuids: string[];
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            }
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            +PolicySetSkeleton | Frodo Library - v4.0.0-11
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Frodo Library - v4.0.0-11
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Type Alias PolicySetSkeleton

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              PolicySetSkeleton: NoIdObjectSkeletonInterface & {
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  name: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  resourceTypeUuids: string[];
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              }
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              diff --git a/docs/types/Reference.PolicySkeleton.html b/docs/types/Reference.PolicySkeleton.html index dc5bc1815..16241d382 100644 --- a/docs/types/Reference.PolicySkeleton.html +++ b/docs/types/Reference.PolicySkeleton.html @@ -1 +1 @@ -PolicySkeleton | Frodo Library - v4.0.0-10
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Frodo Library - v4.0.0-10
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Type Alias PolicySkeleton

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                PolicySkeleton: IdObjectSkeletonInterface & {
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    applicationName: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    condition?: PolicyCondition;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    name: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    resourceTypeUuid: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                }
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                +PolicySkeleton | Frodo Library - v4.0.0-11
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Frodo Library - v4.0.0-11
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Type Alias PolicySkeleton

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  PolicySkeleton: IdObjectSkeletonInterface & {
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      applicationName: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      condition?: PolicyCondition;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      name: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      resourceTypeUuid: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  }
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  diff --git a/docs/types/Reference.ProgressIndicatorStatusType.html b/docs/types/Reference.ProgressIndicatorStatusType.html index 846c82843..ad502a12c 100644 --- a/docs/types/Reference.ProgressIndicatorStatusType.html +++ b/docs/types/Reference.ProgressIndicatorStatusType.html @@ -1 +1 @@ -ProgressIndicatorStatusType | Frodo Library - v4.0.0-10
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Frodo Library - v4.0.0-10
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Type Alias ProgressIndicatorStatusType

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    ProgressIndicatorStatusType: "none" | "success" | "warn" | "fail"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    +ProgressIndicatorStatusType | Frodo Library - v4.0.0-11
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Frodo Library - v4.0.0-11
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Type Alias ProgressIndicatorStatusType

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      ProgressIndicatorStatusType: "none" | "success" | "warn" | "fail"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      diff --git a/docs/types/Reference.ProgressIndicatorType.html b/docs/types/Reference.ProgressIndicatorType.html index ae4a8d6c0..5ce3bfb65 100644 --- a/docs/types/Reference.ProgressIndicatorType.html +++ b/docs/types/Reference.ProgressIndicatorType.html @@ -1 +1 @@ -ProgressIndicatorType | Frodo Library - v4.0.0-10
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Frodo Library - v4.0.0-10
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Type Alias ProgressIndicatorType

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        ProgressIndicatorType: "determinate" | "indeterminate"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        +ProgressIndicatorType | Frodo Library - v4.0.0-11
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Frodo Library - v4.0.0-11
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Type Alias ProgressIndicatorType

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          ProgressIndicatorType: "determinate" | "indeterminate"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          diff --git a/docs/types/Reference.Readable.html b/docs/types/Reference.Readable.html index 3402228f6..dd59c3afa 100644 --- a/docs/types/Reference.Readable.html +++ b/docs/types/Reference.Readable.html @@ -1 +1 @@ -Readable | Frodo Library - v4.0.0-10
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Frodo Library - v4.0.0-10
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Type Alias Readable<Type>

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Readable: Type

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Type Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • Type
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            +Readable | Frodo Library - v4.0.0-11
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Frodo Library - v4.0.0-11
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Type Alias Readable<Type>

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Readable: Type

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Type Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • Type
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              diff --git a/docs/types/Reference.Realm.html b/docs/types/Reference.Realm.html index 0b010ddbd..cb22ccafe 100644 --- a/docs/types/Reference.Realm.html +++ b/docs/types/Reference.Realm.html @@ -1,4 +1,4 @@ -Realm | Frodo Library - v4.0.0-10
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Frodo Library - v4.0.0-10
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Type Alias Realm

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                type Realm = {
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    addCustomDomain(
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        realmName: string,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        domain: string,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    ): Promise<RealmSkeleton>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    createRealm(
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        realmName: string,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        realmData?: RealmSkeleton,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    ): Promise<RealmSkeleton>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    deleteRealm(realmId: string): Promise<RealmSkeleton>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    deleteRealmByName(realmName: string): Promise<RealmSkeleton>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    exportRealms(): Promise<RealmExportInterface>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    getRealmByName(realmName: string): Promise<RealmSkeleton>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    getRealms(): Promise<RealmSkeleton[]>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    importRealms(
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        importData: RealmExportInterface,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        realmId?: string,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        realmName?: string,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    ): Promise<RealmSkeleton[]>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    putRealm(realmId: string, realmData: RealmSkeleton): Promise<RealmSkeleton>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    readRealm(realmId: string): Promise<RealmSkeleton>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    readRealmByName(realmName: string): Promise<RealmSkeleton>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    readRealms(): Promise<RealmSkeleton[]>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    removeCustomDomain(
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        realmName: string,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        domain: string,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    ): Promise<RealmSkeleton>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    updateRealm(
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        realmId: string,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        realmData: RealmSkeleton,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    ): Promise<RealmSkeleton>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                }
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Index

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Methods

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                addCustomDomain +Realm | Frodo Library - v4.0.0-11
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Frodo Library - v4.0.0-11
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Type Alias Realm

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  type Realm = {
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      addCustomDomain(
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          realmName: string,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          domain: string,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      ): Promise<RealmSkeleton>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      createRealm(
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          realmName: string,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          realmData?: RealmSkeleton,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      ): Promise<RealmSkeleton>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      deleteRealm(realmId: string): Promise<RealmSkeleton>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      deleteRealmByName(realmName: string): Promise<RealmSkeleton>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      exportRealms(): Promise<RealmExportInterface>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      getRealmByName(realmName: string): Promise<RealmSkeleton>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      getRealms(): Promise<RealmSkeleton[]>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      importRealms(
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          importData: RealmExportInterface,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          realmId?: string,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          realmName?: string,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      ): Promise<RealmSkeleton[]>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      putRealm(realmId: string, realmData: RealmSkeleton): Promise<RealmSkeleton>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      readRealm(realmId: string): Promise<RealmSkeleton>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      readRealmByName(realmName: string): Promise<RealmSkeleton>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      readRealms(): Promise<RealmSkeleton[]>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      removeCustomDomain(
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          realmName: string,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          domain: string,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      ): Promise<RealmSkeleton>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      updateRealm(
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          realmId: string,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          realmData: RealmSkeleton,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      ): Promise<RealmSkeleton>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  }
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Index

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Methods

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • realmName: string

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    realm name

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • domain: string

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    domain name

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Returns Promise<RealmSkeleton>

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  a promise resolving to a realm object

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • Import realms

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • importData: RealmExportInterface

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      realm import data

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • OptionalrealmId: string

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Optional realm id. If supplied, only the realm of that id is imported. Takes priority over realmName if both are provided.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • OptionalrealmName: string

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Optional realm name. If supplied, only the realm of that name is imported.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Returns Promise<RealmSkeleton[]>

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    the imported realms

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • Remove custom DNS domain name (realm DNS alias)

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • Remove custom DNS domain name (realm DNS alias)

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • realmName: string

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      realm name

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • domain: string

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      domain name

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Returns Promise<RealmSkeleton>

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    a promise resolving to a realm object

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Deprecated

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Deprecated

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • Get realm by name

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • realmName: string

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      realm name

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Returns Promise<RealmSkeleton>

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    a promise resolving to a realm object

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    since v2.0.0 use readRealmByName instead

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    readRealmByName(realmName: string): Promise<RealmSkeleton>
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                     
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  diff --git a/docs/types/Reference.RealmSkeleton.html b/docs/types/Reference.RealmSkeleton.html index e6f4ef352..0cb3fe70c 100644 --- a/docs/types/Reference.RealmSkeleton.html +++ b/docs/types/Reference.RealmSkeleton.html @@ -1 +1 @@ -RealmSkeleton | Frodo Library - v4.0.0-10
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Frodo Library - v4.0.0-10
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Type Alias RealmSkeleton

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    RealmSkeleton: IdObjectSkeletonInterface & {
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        active: boolean;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        aliases: string[];
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        name: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        parentPath: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    }
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    +RealmSkeleton | Frodo Library - v4.0.0-11
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Frodo Library - v4.0.0-11
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Type Alias RealmSkeleton

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      RealmSkeleton: IdObjectSkeletonInterface & {
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          active: boolean;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          aliases: string[];
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          name: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          parentPath: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      }
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      diff --git a/docs/types/Reference.Recon.html b/docs/types/Reference.Recon.html index a7f95f579..86aa0c54f 100644 --- a/docs/types/Reference.Recon.html +++ b/docs/types/Reference.Recon.html @@ -1,4 +1,4 @@ -Recon | Frodo Library - v4.0.0-10
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Frodo Library - v4.0.0-10
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Type Alias Recon

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        type Recon = {
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            cancelRecon(reconId: string): Promise<ReconStatusType>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            readRecon(reconId: string): Promise<ReconType>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            readRecons(): Promise<ReconType[]>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            startRecon(mappingName: string): Promise<ReconStatusType>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            startReconById(
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                mappingName: string,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                objectId: string,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            ): Promise<ReconStatusType>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        }
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Index

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Methods

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        cancelRecon +Recon | Frodo Library - v4.0.0-11
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Frodo Library - v4.0.0-11
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Type Alias Recon

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          type Recon = {
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              cancelRecon(reconId: string): Promise<ReconStatusType>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              readRecon(reconId: string): Promise<ReconType>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              readRecons(): Promise<ReconType[]>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              startRecon(mappingName: string): Promise<ReconStatusType>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              startReconById(
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  mappingName: string,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  objectId: string,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              ): Promise<ReconStatusType>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          }
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Index

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Methods

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Methods

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • Read recon

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • reconId: string

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              id of the recon

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Returns Promise<ReconType>

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            a promise resolving to a recon object

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • Start a reconciliation by Id

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • mappingName: string

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              mapping to reconcile

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • objectId: string

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              id of object to reconcile

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Returns Promise<ReconStatusType>

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            a promise resolving to a recon status object

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          diff --git a/docs/types/Reference.ReconStatusType.html b/docs/types/Reference.ReconStatusType.html index e86ee3b0a..beace4181 100644 --- a/docs/types/Reference.ReconStatusType.html +++ b/docs/types/Reference.ReconStatusType.html @@ -1 +1 @@ -ReconStatusType | Frodo Library - v4.0.0-10
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Frodo Library - v4.0.0-10
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Type Alias ReconStatusType

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            ReconStatusType: IdObjectSkeletonInterface & {
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                action: "cancel" | string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                state: "ACTIVE" | string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                status: "INITIATED" | string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            }
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            +ReconStatusType | Frodo Library - v4.0.0-11
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Frodo Library - v4.0.0-11
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Type Alias ReconStatusType

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              ReconStatusType: IdObjectSkeletonInterface & {
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  action: "cancel" | string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  state: "ACTIVE" | string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  status: "INITIATED" | string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              }
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              diff --git a/docs/types/Reference.ReconType.html b/docs/types/Reference.ReconType.html index 87f4d753c..6b8da50ad 100644 --- a/docs/types/Reference.ReconType.html +++ b/docs/types/Reference.ReconType.html @@ -1 +1 @@ -ReconType | Frodo Library - v4.0.0-10
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Frodo Library - v4.0.0-10
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Type Alias ReconType

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                ReconType: IdObjectSkeletonInterface & {
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    duration: number;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    durationSummary: {
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        auditLog: {
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            count: number;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            max: number;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            mean: number;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            min: number;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            stdDev: number;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            sum: number;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        };
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        defaultPropertyMapping: {
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            count: number;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            max: number;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            mean: number;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            min: number;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            stdDev: number;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            sum: number;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        };
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        propertyMappingScript: {
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            count: number;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            max: number;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            mean: number;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            min: number;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            stdDev: number;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            sum: number;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        };
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        sourceLinkQuery: {
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            count: number;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            max: number;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            mean: number;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            min: number;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            stdDev: number;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            sum: number;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        };
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        sourcePhase: {
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            count: number;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            max: number;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            mean: number;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            min: number;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            stdDev: number;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            sum: number;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        };
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        sourceQuery: {
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            count: number;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            max: number;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            mean: number;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            min: number;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            stdDev: number;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            sum: number;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        };
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        targetObjectQuery: {
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            count: number;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            max: number;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            mean: number;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            min: number;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            stdDev: number;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            sum: number;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        };
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        updateLastSync: {
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            count: number;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            max: number;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            mean: number;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            min: number;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            stdDev: number;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            sum: number;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        };
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        updateTargetObject: {
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            count: number;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            max: number;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            mean: number;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            min: number;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            stdDev: number;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            sum: number;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        };
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    };
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    ended: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    mapping: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    parameters: {
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        sourceIds: [string];
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        sourceQuery: {
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            _fields: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            _queryFilter: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            resourceName: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        };
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        targetQuery: {
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            _fields: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            queryFilter: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            resourceName: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        };
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    };
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    progress: {
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        links: {
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            created: number;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            existing: { processed: number; total: string };
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        };
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        source: { existing: { processed: number; total: string } };
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        target: {
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            created: number;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            deleted: number;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            existing: { processed: number; total: string };
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            unchanged: number;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            updated: number;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        };
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    };
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    situationSummary: {
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        ABSENT: number;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        ALL_GONE: number;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        AMBIGUOUS: number;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        CONFIRMED: number;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        FOUND: number;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        FOUND_ALREADY_LINKED: number;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        LINK_ONLY: number;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        MISSING: number;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        SOURCE_IGNORED: number;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        SOURCE_MISSING: number;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        SOURCE_TARGET_CONFLICT: number;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        TARGET_CHANGED: number;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        TARGET_IGNORED: number;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        UNASSIGNED: number;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        UNQUALIFIED: number;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    };
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    sourceProcessedByNode: object;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    stage: "COMPLETED_SUCCESS"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    | string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    stageDescription: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    started: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    state: "SUCCESS" | string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    statusSummary: { FAILURE: number; SUCCESS: number };
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                }
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                +ReconType | Frodo Library - v4.0.0-11
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Frodo Library - v4.0.0-11
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Type Alias ReconType

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  ReconType: IdObjectSkeletonInterface & {
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      duration: number;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      durationSummary: {
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          auditLog: {
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              count: number;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              max: number;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              mean: number;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              min: number;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              stdDev: number;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              sum: number;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          };
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          defaultPropertyMapping: {
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              count: number;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              max: number;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              mean: number;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              min: number;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              stdDev: number;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              sum: number;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          };
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          propertyMappingScript: {
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              count: number;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              max: number;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              mean: number;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              min: number;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              stdDev: number;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              sum: number;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          };
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          sourceLinkQuery: {
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              count: number;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              max: number;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              mean: number;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              min: number;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              stdDev: number;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              sum: number;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          };
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          sourcePhase: {
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              count: number;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              max: number;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              mean: number;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              min: number;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              stdDev: number;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              sum: number;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          };
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          sourceQuery: {
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              count: number;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              max: number;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              mean: number;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              min: number;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              stdDev: number;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              sum: number;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          };
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          targetObjectQuery: {
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              count: number;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              max: number;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              mean: number;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              min: number;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              stdDev: number;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              sum: number;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          };
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          updateLastSync: {
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              count: number;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              max: number;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              mean: number;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              min: number;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              stdDev: number;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              sum: number;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          };
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          updateTargetObject: {
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              count: number;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              max: number;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              mean: number;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              min: number;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              stdDev: number;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              sum: number;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          };
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      };
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      ended: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      mapping: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      parameters: {
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          sourceIds: [string];
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          sourceQuery: {
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              _fields: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              _queryFilter: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              resourceName: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          };
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          targetQuery: {
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              _fields: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              queryFilter: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              resourceName: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          };
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      };
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      progress: {
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          links: {
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              created: number;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              existing: { processed: number; total: string };
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          };
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          source: { existing: { processed: number; total: string } };
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          target: {
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              created: number;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              deleted: number;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              existing: { processed: number; total: string };
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              unchanged: number;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              updated: number;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          };
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      };
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      situationSummary: {
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          ABSENT: number;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          ALL_GONE: number;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          AMBIGUOUS: number;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          CONFIRMED: number;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          FOUND: number;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          FOUND_ALREADY_LINKED: number;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          LINK_ONLY: number;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          MISSING: number;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          SOURCE_IGNORED: number;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          SOURCE_MISSING: number;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          SOURCE_TARGET_CONFLICT: number;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          TARGET_CHANGED: number;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          TARGET_IGNORED: number;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          UNASSIGNED: number;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          UNQUALIFIED: number;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      };
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      sourceProcessedByNode: object;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      stage: "COMPLETED_SUCCESS"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      | string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      stageDescription: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      started: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      state: "SUCCESS" | string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      statusSummary: { FAILURE: number; SUCCESS: number };
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  }
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  diff --git a/docs/types/Reference.ResourceType.html b/docs/types/Reference.ResourceType.html index dfa6c0d24..79d876fbb 100644 --- a/docs/types/Reference.ResourceType.html +++ b/docs/types/Reference.ResourceType.html @@ -1,4 +1,4 @@ -ResourceType | Frodo Library - v4.0.0-10
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Frodo Library - v4.0.0-10
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Type Alias ResourceType

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    type ResourceType = {
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        createResourceType(
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            resourceTypeData: ResourceTypeSkeleton,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            resourceTypeUuid?: string,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        ): Promise<ResourceTypeSkeleton>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        deleteResourceType(resourceTypeUuid: string): Promise<ResourceTypeSkeleton>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        deleteResourceTypeByName(
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            resourceTypeName: string,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        ): Promise<ResourceTypeSkeleton>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        exportResourceType(
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            resourceTypeUuid: string,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        ): Promise<ResourceTypeExportInterface>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        exportResourceTypeByName(
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            resourceTypeName: string,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        ): Promise<ResourceTypeExportInterface>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        exportResourceTypes(): Promise<ResourceTypeExportInterface>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        getResourceType(resourceTypeUuid: string): Promise<ResourceTypeSkeleton>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        getResourceTypeByName(
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            resourceTypeName: string,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        ): Promise<ResourceTypeSkeleton>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        getResourceTypes(): Promise<ResourceTypeSkeleton[]>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        importFirstResourceType(
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            importData: ResourceTypeExportInterface,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        ): Promise<any>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        importResourceType(
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            resourceTypeUuid: string,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            importData: ResourceTypeExportInterface,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        ): Promise<any>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        importResourceTypeByName(
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            resourceTypeName: string,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            importData: ResourceTypeExportInterface,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        ): Promise<any>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        importResourceTypes(
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            importData: ResourceTypeExportInterface,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        ): Promise<any[]>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        readResourceType(resourceTypeUuid: string): Promise<ResourceTypeSkeleton>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        readResourceTypeByName(
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            resourceTypeName: string,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        ): Promise<ResourceTypeSkeleton>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        readResourceTypes(): Promise<ResourceTypeSkeleton[]>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        updateResourceType(
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            resourceTypeUuid: string,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            resourceTypeData: ResourceTypeSkeleton,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        ): Promise<ResourceTypeSkeleton>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    }
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Index

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Methods

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    createResourceType +ResourceType | Frodo Library - v4.0.0-11
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Frodo Library - v4.0.0-11
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Type Alias ResourceType

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      type ResourceType = {
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          createResourceType(
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              resourceTypeData: ResourceTypeSkeleton,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              resourceTypeUuid?: string,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          ): Promise<ResourceTypeSkeleton>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          deleteResourceType(resourceTypeUuid: string): Promise<ResourceTypeSkeleton>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          deleteResourceTypeByName(
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              resourceTypeName: string,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          ): Promise<ResourceTypeSkeleton>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          exportResourceType(
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              resourceTypeUuid: string,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          ): Promise<ResourceTypeExportInterface>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          exportResourceTypeByName(
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              resourceTypeName: string,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          ): Promise<ResourceTypeExportInterface>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          exportResourceTypes(): Promise<ResourceTypeExportInterface>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          getResourceType(resourceTypeUuid: string): Promise<ResourceTypeSkeleton>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          getResourceTypeByName(
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              resourceTypeName: string,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          ): Promise<ResourceTypeSkeleton>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          getResourceTypes(): Promise<ResourceTypeSkeleton[]>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          importFirstResourceType(
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              importData: ResourceTypeExportInterface,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          ): Promise<any>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          importResourceType(
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              resourceTypeUuid: string,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              importData: ResourceTypeExportInterface,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          ): Promise<any>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          importResourceTypeByName(
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              resourceTypeName: string,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              importData: ResourceTypeExportInterface,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          ): Promise<any>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          importResourceTypes(
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              importData: ResourceTypeExportInterface,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          ): Promise<any[]>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          readResourceType(resourceTypeUuid: string): Promise<ResourceTypeSkeleton>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          readResourceTypeByName(
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              resourceTypeName: string,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          ): Promise<ResourceTypeSkeleton>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          readResourceTypes(): Promise<ResourceTypeSkeleton[]>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          updateResourceType(
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              resourceTypeUuid: string,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              resourceTypeData: ResourceTypeSkeleton,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          ): Promise<ResourceTypeSkeleton>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      }
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Index

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Methods

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • resourceTypeData: ResourceTypeSkeleton

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        resource type data

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • OptionalresourceTypeUuid: string

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        resource type uuid

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Returns Promise<ResourceTypeSkeleton>

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      a promise that resolves to a resource type object

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • Import resource type by uuid

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Returns Promise<any>

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • Import resource type by name

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Returns Promise<any>

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Returns Promise<any>

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Returns Promise<any[]>

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Deprecated

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Deprecated

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • Get resource type

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • resourceTypeUuid: string

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          resource type uuid

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Returns Promise<ResourceTypeSkeleton>

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        a promise that resolves to a resource type object

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        since v2.0.0 use Agent.readResourceType | readResourceType instead

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        readResourceType(resourceTypeUuid: string): Promise<ResourceTypeSkeleton>
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                         
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • Get resource type by name

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • resourceTypeName: string

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          resource type name

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Returns Promise<ResourceTypeSkeleton>

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        a promise that resolves to a resource type object

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        since v2.0.0 use Agent.readResourceTypeByName | readResourceTypeByName instead

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        readResourceTypeByName(resourceTypeName: string): Promise<ResourceTypeSkeleton>
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                         
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • Get all resource types

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Returns Promise<ResourceTypeSkeleton[]>

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        a promise that resolves to an array of resource type objects

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        since v2.0.0 use Agent.readResourceTypes | readResourceTypes instead

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        readResourceTypes(): Promise<ResourceTypeSkeleton[]>
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                         
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      diff --git a/docs/types/Reference.ResourceTypeSkeleton.html b/docs/types/Reference.ResourceTypeSkeleton.html index 48740afc5..aacd79e61 100644 --- a/docs/types/Reference.ResourceTypeSkeleton.html +++ b/docs/types/Reference.ResourceTypeSkeleton.html @@ -1 +1 @@ -ResourceTypeSkeleton | Frodo Library - v4.0.0-10
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Frodo Library - v4.0.0-10
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Type Alias ResourceTypeSkeleton

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        ResourceTypeSkeleton: NoIdObjectSkeletonInterface & {
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            name: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            uuid: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        }
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        +ResourceTypeSkeleton | Frodo Library - v4.0.0-11
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Frodo Library - v4.0.0-11
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Type Alias ResourceTypeSkeleton

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          ResourceTypeSkeleton: NoIdObjectSkeletonInterface & {
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              name: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              uuid: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          }
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          diff --git a/docs/types/Reference.Saml2.html b/docs/types/Reference.Saml2.html index f1774d0c0..9a930b696 100644 --- a/docs/types/Reference.Saml2.html +++ b/docs/types/Reference.Saml2.html @@ -1,4 +1,4 @@ -Saml2 | Frodo Library - v4.0.0-10
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Frodo Library - v4.0.0-10
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Type Alias Saml2

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            type Saml2 = {
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                createSaml2Provider(
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    location: Saml2ProiderLocation,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    providerData: Saml2ProviderSkeleton,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    metaData: string,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                ): Promise<Saml2ProviderSkeleton>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                deleteSaml2Provider(entityId: string): Promise<Saml2ProviderSkeleton>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                deleteSaml2Providers(): Promise<Saml2ProviderSkeleton[]>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                exportSaml2Provider(
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    entityId: string,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    options?: Saml2EntitiesExportOptions,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                ): Promise<Saml2ExportInterface>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                exportSaml2Providers(
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    options?: Saml2EntitiesExportOptions,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                ): Promise<Saml2ExportInterface>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                getProviderMetadata(entityId: string): Promise<any>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                getProviderMetadataUrl(entityId: string): string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                getSaml2Provider(entityId: string): Promise<Saml2ProviderSkeleton>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                getSaml2ProviderMetadata(entityId: string): Promise<any>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                getSaml2ProviderMetadataUrl(entityId: string): string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                getSaml2ProviderStub(entityId: string): Promise<Saml2ProviderStub>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                getSaml2ProviderStubs(): Promise<Saml2ProviderStub[]>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                importSaml2Provider(
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    entityId: string,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    importData: Saml2ExportInterface,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    options?: Saml2EntitiesImportOptions,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                ): Promise<Saml2ProviderSkeleton>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                importSaml2Providers(
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    importData: Saml2ExportInterface,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    options?: Saml2EntitiesImportOptions,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                ): Promise<Saml2ProviderSkeleton[]>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                readSaml2Provider(entityId: string): Promise<Saml2ProviderSkeleton>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                readSaml2ProviderStub(entityId: string): Promise<Saml2ProviderStub>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                readSaml2ProviderStubs(): Promise<Saml2ProviderStub[]>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                updateSaml2Provider(
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    location: Saml2ProiderLocation,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    providerData: Saml2ProviderSkeleton,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    entityId?: string,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                ): Promise<Saml2ProviderSkeleton>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            }
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Index

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Methods

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            createSaml2Provider +Saml2 | Frodo Library - v4.0.0-11
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Frodo Library - v4.0.0-11
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Type Alias Saml2

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              type Saml2 = {
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  createSaml2Provider(
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      location: Saml2ProiderLocation,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      providerData: Saml2ProviderSkeleton,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      metaData: string,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  ): Promise<Saml2ProviderSkeleton>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  deleteSaml2Provider(entityId: string): Promise<Saml2ProviderSkeleton>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  deleteSaml2Providers(): Promise<Saml2ProviderSkeleton[]>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  exportSaml2Provider(
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      entityId: string,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      options?: Saml2EntitiesExportOptions,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  ): Promise<Saml2ExportInterface>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  exportSaml2Providers(
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      options?: Saml2EntitiesExportOptions,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  ): Promise<Saml2ExportInterface>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  getProviderMetadata(entityId: string): Promise<any>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  getProviderMetadataUrl(entityId: string): string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  getSaml2Provider(entityId: string): Promise<Saml2ProviderSkeleton>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  getSaml2ProviderMetadata(entityId: string): Promise<any>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  getSaml2ProviderMetadataUrl(entityId: string): string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  getSaml2ProviderStub(entityId: string): Promise<Saml2ProviderStub>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  getSaml2ProviderStubs(): Promise<Saml2ProviderStub[]>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  importSaml2Provider(
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      entityId: string,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      importData: Saml2ExportInterface,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      options?: Saml2EntitiesImportOptions,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  ): Promise<Saml2ProviderSkeleton>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  importSaml2Providers(
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      importData: Saml2ExportInterface,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      options?: Saml2EntitiesImportOptions,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  ): Promise<Saml2ProviderSkeleton[]>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  readSaml2Provider(entityId: string): Promise<Saml2ProviderSkeleton>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  readSaml2ProviderStub(entityId: string): Promise<Saml2ProviderStub>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  readSaml2ProviderStubs(): Promise<Saml2ProviderStub[]>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  updateSaml2Provider(
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      location: Saml2ProiderLocation,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      providerData: Saml2ProviderSkeleton,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      entityId?: string,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  ): Promise<Saml2ProviderSkeleton>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              }
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Index

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Methods

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • providerData: Saml2ProviderSkeleton

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Object representing a SAML entity provider

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • metaData: string

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Base64-encoded metadata XML. Only required for remote providers

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • Returns Promise<Saml2ProviderSkeleton>

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              a promise that resolves to a saml2 entity provider object

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • Delete an entity provider. The response can be saved to file as is.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • entityId: string

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Provider entity id

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Returns Promise<Saml2ProviderSkeleton>

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Promise resolving to a Saml2ExportInterface object.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • Get a SAML2 entity provider's metadata by entity id

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • Get a SAML2 entity provider's metadata by entity id

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • entityId: string

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  SAML2 entity id

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Returns Promise<any>

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                a promise that resolves to an object containing a SAML2 metadata

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • Get a SAML2 entity provider's metadata URL by entity id

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • Get a SAML2 entity provider's metadata URL by entity id

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • entityId: string

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  SAML2 entity id

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Returns string

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                the URL to get the metadata from

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • Export a single entity provider. The response can be saved to file as is.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • entityId: string

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Provider entity id

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Returns Promise<Saml2ProviderSkeleton>

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Promise resolving to a Saml2ExportInterface object.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Deprecated

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • Get a SAML2 entity provider's metadata by entity id

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Deprecated

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • Get a SAML2 entity provider's metadata by entity id

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • entityId: string

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  SAML2 entity id

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Returns Promise<any>

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                a promise that resolves to an object containing a SAML2 metadata

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                since v2.0.0 use getSaml2ProviderMetadata instead

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                getSaml2ProviderMetadata(entityId: string): Promise<any>
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                 
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • Get a SAML2 entity provider's metadata URL by entity id

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • Get a SAML2 entity provider's metadata URL by entity id

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • entityId: string

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  SAML2 entity id

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Returns string

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                the URL to get the metadata from

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                since v2.0.0 use getSaml2ProviderMetadataUrl instead

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                getSaml2ProviderMetadataUrl(entityId: string): string
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                 
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              diff --git a/docs/types/Reference.Saml2ProiderLocation.html b/docs/types/Reference.Saml2ProiderLocation.html index 915356726..7bc2b7656 100644 --- a/docs/types/Reference.Saml2ProiderLocation.html +++ b/docs/types/Reference.Saml2ProiderLocation.html @@ -1 +1 @@ -Saml2ProiderLocation | Frodo Library - v4.0.0-10
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Frodo Library - v4.0.0-10
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Type Alias Saml2ProiderLocation

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Saml2ProiderLocation: "hosted" | "remote"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                +Saml2ProiderLocation | Frodo Library - v4.0.0-11
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Frodo Library - v4.0.0-11
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Type Alias Saml2ProiderLocation

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Saml2ProiderLocation: "hosted" | "remote"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  diff --git a/docs/types/Reference.Saml2ProviderSkeleton.html b/docs/types/Reference.Saml2ProviderSkeleton.html index a77496fa5..6e1546ddf 100644 --- a/docs/types/Reference.Saml2ProviderSkeleton.html +++ b/docs/types/Reference.Saml2ProviderSkeleton.html @@ -1 +1 @@ -Saml2ProviderSkeleton | Frodo Library - v4.0.0-10
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Frodo Library - v4.0.0-10
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Type Alias Saml2ProviderSkeleton

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Saml2ProviderSkeleton: IdObjectSkeletonInterface & {
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        attributeQueryProvider: unknown;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        entityId: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        entityLocation: Saml2ProiderLocation;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        identityProvider: {
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            advanced?: { idpAdapter?: { idpAdapterScript?: string } };
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            assertionProcessing?: {
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                attributeMapper?: { attributeMapperScript?: string };
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            };
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        };
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        serviceProvider: unknown;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        xacmlPolicyEnforcementPoint: unknown;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    }
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    +Saml2ProviderSkeleton | Frodo Library - v4.0.0-11
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Frodo Library - v4.0.0-11
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Type Alias Saml2ProviderSkeleton

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Saml2ProviderSkeleton: IdObjectSkeletonInterface & {
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          attributeQueryProvider: unknown;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          entityId: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          entityLocation: Saml2ProiderLocation;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          identityProvider: {
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              advanced?: { idpAdapter?: { idpAdapterScript?: string } };
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              assertionProcessing?: {
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  attributeMapper?: { attributeMapperScript?: string };
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              };
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          };
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          serviceProvider: unknown;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          xacmlPolicyEnforcementPoint: unknown;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      }
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      diff --git a/docs/types/Reference.Saml2ProviderStub.html b/docs/types/Reference.Saml2ProviderStub.html index 87679e8f8..7568c4e5b 100644 --- a/docs/types/Reference.Saml2ProviderStub.html +++ b/docs/types/Reference.Saml2ProviderStub.html @@ -1 +1 @@ -Saml2ProviderStub | Frodo Library - v4.0.0-10
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Frodo Library - v4.0.0-10
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Type Alias Saml2ProviderStub

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Saml2ProviderStub: IdObjectSkeletonInterface & {
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            entityId: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            location: Saml2ProiderLocation;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            roles: string[];
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        }
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        +Saml2ProviderStub | Frodo Library - v4.0.0-11
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Frodo Library - v4.0.0-11
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Type Alias Saml2ProviderStub

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Saml2ProviderStub: IdObjectSkeletonInterface & {
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              entityId: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              location: Saml2ProiderLocation;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              roles: string[];
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          }
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          diff --git a/docs/types/Reference.Script.html b/docs/types/Reference.Script.html index eb80d77dc..fc0b3eb5c 100644 --- a/docs/types/Reference.Script.html +++ b/docs/types/Reference.Script.html @@ -1,4 +1,4 @@ -Script | Frodo Library - v4.0.0-10
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Frodo Library - v4.0.0-10
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Type Alias Script

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            type Script = {
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                createScript(
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    scriptId: string,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    scriptName: string,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    scriptData: ScriptSkeleton,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                ): Promise<ScriptSkeleton>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                createScriptExportTemplate(): ScriptExportInterface;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                deleteScript(scriptId: string): Promise<ScriptSkeleton>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                deleteScriptByName(scriptName: string): Promise<ScriptSkeleton>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                deleteScripts(
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    resultCallback?: ResultCallback<ScriptSkeleton>,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                ): Promise<ScriptSkeleton[]>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                exportScript(
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    scriptId: string,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    options?: ScriptExportOptions,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                ): Promise<ScriptExportInterface>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                exportScriptByName(
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    scriptName: string,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    options?: ScriptExportOptions,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                ): Promise<ScriptExportInterface>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                exportScripts(
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    options?: ScriptExportOptions,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    resultCallback?: ResultCallback<ScriptSkeleton>,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                ): Promise<ScriptExportInterface>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                getLibraryScriptNames(scriptObj: ScriptSkeleton): string[];
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                getScript(scriptId: string): Promise<ScriptSkeleton>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                getScriptByName(scriptName: string): Promise<ScriptSkeleton>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                getScripts(): Promise<ScriptSkeleton[]>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                importScripts(
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    scriptId: string,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    scriptName: string,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    importData: ScriptExportInterface,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    options?: ScriptImportOptions,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    validate?: boolean,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    resultCallback?: ResultCallback<ScriptSkeleton>,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                ): Promise<ScriptSkeleton[]>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                putScript(
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    scriptId: string,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    scriptData: ScriptSkeleton,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                ): Promise<ScriptSkeleton>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                readScript(scriptId: string): Promise<ScriptSkeleton>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                readScriptByName(scriptName: string): Promise<ScriptSkeleton>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                readScripts(): Promise<ScriptSkeleton[]>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                updateScript(
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    scriptId: string,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    scriptData: ScriptSkeleton,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                ): Promise<ScriptSkeleton>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            }
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Index

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Methods

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            createScript +Script | Frodo Library - v4.0.0-11
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Frodo Library - v4.0.0-11
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Type Alias Script

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              type Script = {
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  createScript(
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      scriptId: string,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      scriptName: string,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      scriptData: ScriptSkeleton,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  ): Promise<ScriptSkeleton>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  createScriptExportTemplate(): ScriptExportInterface;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  deleteScript(scriptId: string): Promise<ScriptSkeleton>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  deleteScriptByName(scriptName: string): Promise<ScriptSkeleton>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  deleteScripts(
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      resultCallback?: ResultCallback<ScriptSkeleton>,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  ): Promise<ScriptSkeleton[]>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  exportScript(
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      scriptId: string,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      options?: ScriptExportOptions,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  ): Promise<ScriptExportInterface>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  exportScriptByName(
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      scriptName: string,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      options?: ScriptExportOptions,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  ): Promise<ScriptExportInterface>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  exportScripts(
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      options?: ScriptExportOptions,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      resultCallback?: ResultCallback<ScriptSkeleton>,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  ): Promise<ScriptExportInterface>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  getLibraryScriptNames(scriptObj: ScriptSkeleton): string[];
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  getScript(scriptId: string): Promise<ScriptSkeleton>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  getScriptByName(scriptName: string): Promise<ScriptSkeleton>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  getScripts(): Promise<ScriptSkeleton[]>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  importScripts(
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      scriptId: string,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      scriptName: string,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      importData: ScriptExportInterface,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      options?: ScriptImportOptions,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      validate?: boolean,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      resultCallback?: ResultCallback<ScriptSkeleton>,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  ): Promise<ScriptSkeleton[]>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  putScript(
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      scriptId: string,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      scriptData: ScriptSkeleton,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  ): Promise<ScriptSkeleton>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  readScript(scriptId: string): Promise<ScriptSkeleton>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  readScriptByName(scriptName: string): Promise<ScriptSkeleton>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  readScripts(): Promise<ScriptSkeleton[]>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  updateScript(
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      scriptId: string,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      scriptData: ScriptSkeleton,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  ): Promise<ScriptSkeleton>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              }
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Index

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Methods

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • scriptName: string

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              name of the script

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • scriptData: ScriptSkeleton

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              script object

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • Returns Promise<ScriptSkeleton>

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              a status object

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • Get the names of library scripts required by the input script object

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Returns string[]

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                an array of required library script names

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • Import scripts

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • scriptId: string

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Optional id of script. If supplied, only the script of that id is imported. Takes priority over scriptName if both are provided.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • scriptName: string

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Optional name of script. If supplied, only the script of that name is imported

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • importData: ScriptExportInterface

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Script import data

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  @@ -55,39 +55,39 @@
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • Optionalvalidate: boolean

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  If true, validates Javascript scripts to ensure no errors exist in them. Default: false

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • OptionalresultCallback: ResultCallback<ScriptSkeleton>

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Optional callback to process individual results

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Returns Promise<ScriptSkeleton[]>

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                the imported scripts

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Deprecated

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Deprecated

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • Get script

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • scriptId: string

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  script id

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Returns Promise<ScriptSkeleton>

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                promise that resolves to a script object

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                since v2.0.0 use readScript instead

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                readScript(scriptName: string): Promise<ScriptSkeleton>
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                 
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • Get script by name

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • scriptName: string

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  name of the script

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Returns Promise<ScriptSkeleton>

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                promise that resolves to a script object

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                since v2.0.0 use readScriptByName instead

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                readScriptByName(scriptName: string): Promise<ScriptSkeleton>
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                 
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              diff --git a/docs/types/Reference.ScriptContext.html b/docs/types/Reference.ScriptContext.html index 0ce09103c..866e0aea1 100644 --- a/docs/types/Reference.ScriptContext.html +++ b/docs/types/Reference.ScriptContext.html @@ -1 +1 @@ -ScriptContext | Frodo Library - v4.0.0-10
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Frodo Library - v4.0.0-10
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Type Alias ScriptContext

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                ScriptContext:
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    | "OAUTH2_ACCESS_TOKEN_MODIFICATION"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    | "AUTHENTICATION_CLIENT_SIDE"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    | "AUTHENTICATION_TREE_DECISION_NODE"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    | "AUTHENTICATION_SERVER_SIDE"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    | "SOCIAL_IDP_PROFILE_TRANSFORMATION"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    | "OAUTH2_VALIDATE_SCOPE"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    | "CONFIG_PROVIDER_NODE"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    | "OAUTH2_AUTHORIZE_ENDPOINT_DATA_PROVIDER"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    | "OAUTH2_EVALUATE_SCOPE"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    | "POLICY_CONDITION"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    | "OIDC_CLAIMS"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    | "SAML2_IDP_ADAPTER"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    | "SAML2_IDP_ATTRIBUTE_MAPPER"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    | "OAUTH2_MAY_ACT"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    | "LIBRARY"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                +ScriptContext | Frodo Library - v4.0.0-11
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Frodo Library - v4.0.0-11
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Type Alias ScriptContext

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  ScriptContext:
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      | "OAUTH2_ACCESS_TOKEN_MODIFICATION"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      | "AUTHENTICATION_CLIENT_SIDE"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      | "AUTHENTICATION_TREE_DECISION_NODE"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      | "AUTHENTICATION_SERVER_SIDE"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      | "SOCIAL_IDP_PROFILE_TRANSFORMATION"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      | "OAUTH2_VALIDATE_SCOPE"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      | "CONFIG_PROVIDER_NODE"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      | "OAUTH2_AUTHORIZE_ENDPOINT_DATA_PROVIDER"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      | "OAUTH2_EVALUATE_SCOPE"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      | "POLICY_CONDITION"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      | "OIDC_CLAIMS"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      | "SAML2_IDP_ADAPTER"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      | "SAML2_IDP_ATTRIBUTE_MAPPER"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      | "OAUTH2_MAY_ACT"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      | "LIBRARY"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  diff --git a/docs/types/Reference.ScriptLanguage.html b/docs/types/Reference.ScriptLanguage.html index d509edd04..6fbdfbcd7 100644 --- a/docs/types/Reference.ScriptLanguage.html +++ b/docs/types/Reference.ScriptLanguage.html @@ -1 +1 @@ -ScriptLanguage | Frodo Library - v4.0.0-10
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Frodo Library - v4.0.0-10
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Type Alias ScriptLanguage

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    ScriptLanguage: "GROOVY" | "JAVASCRIPT"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    +ScriptLanguage | Frodo Library - v4.0.0-11
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Frodo Library - v4.0.0-11
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Type Alias ScriptLanguage

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      ScriptLanguage: "GROOVY" | "JAVASCRIPT"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      diff --git a/docs/types/Reference.ScriptSkeleton.html b/docs/types/Reference.ScriptSkeleton.html index ecd2603ac..3277ccef3 100644 --- a/docs/types/Reference.ScriptSkeleton.html +++ b/docs/types/Reference.ScriptSkeleton.html @@ -1 +1 @@ -ScriptSkeleton | Frodo Library - v4.0.0-10
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Frodo Library - v4.0.0-10
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Type Alias ScriptSkeleton

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        ScriptSkeleton: IdObjectSkeletonInterface & {
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            context: ScriptContext;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            createdBy: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            creationDate: number;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            default: boolean;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            description: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            exports?: { arity?: number; id: string; type: string }[];
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            language: ScriptLanguage;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            lastModifiedBy: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            lastModifiedDate: number;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            name: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            script: string | string[];
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        }
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        +ScriptSkeleton | Frodo Library - v4.0.0-11
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Frodo Library - v4.0.0-11
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Type Alias ScriptSkeleton

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          ScriptSkeleton: IdObjectSkeletonInterface & {
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              context: ScriptContext;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              createdBy: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              creationDate: number;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              default: boolean;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              description: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              exports?: { arity?: number; id: string; type: string }[];
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              language: ScriptLanguage;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              lastModifiedBy: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              lastModifiedDate: number;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              name: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              script: string | string[];
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          }
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          diff --git a/docs/types/Reference.ScriptValidation.html b/docs/types/Reference.ScriptValidation.html index 7f88b88a7..e72eaf498 100644 --- a/docs/types/Reference.ScriptValidation.html +++ b/docs/types/Reference.ScriptValidation.html @@ -1,7 +1,7 @@ -ScriptValidation | Frodo Library - v4.0.0-10
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Frodo Library - v4.0.0-10
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Type Alias ScriptValidation

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            type ScriptValidation = {
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                areScriptHooksValid(jsonData: object): boolean;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                isScriptValid(scriptData: ScriptSkeleton): boolean;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                isValidJs(javascriptSource: string): boolean;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                validateJs(javascriptSource: string): void;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                validateScript(scriptData: ScriptSkeleton): void;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                validateScriptHooks(jsonData: object): void;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            }
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Index

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Methods

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            areScriptHooksValid +ScriptValidation | Frodo Library - v4.0.0-11
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Frodo Library - v4.0.0-11
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Type Alias ScriptValidation

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              type ScriptValidation = {
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  areScriptHooksValid(jsonData: object): boolean;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  isScriptValid(scriptData: ScriptSkeleton): boolean;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  isValidJs(javascriptSource: string): boolean;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  validateJs(javascriptSource: string): void;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  validateScript(scriptData: ScriptSkeleton): void;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  validateScriptHooks(jsonData: object): void;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              }
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Index

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Methods

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Methods

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              diff --git a/docs/types/Reference.Secret.html b/docs/types/Reference.Secret.html index 288a10494..d37e867d3 100644 --- a/docs/types/Reference.Secret.html +++ b/docs/types/Reference.Secret.html @@ -1,4 +1,4 @@ -Secret | Frodo Library - v4.0.0-10
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Frodo Library - v4.0.0-10
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Type Alias Secret

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                type Secret = {
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    createNewVersionOfSecret(
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        secretId: string,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        value: string,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    ): Promise<VersionOfSecretSkeleton>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    createSecret(
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        secretId: string,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        value: string,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        description: string,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        encoding?: string,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        useInPlaceholders?: boolean,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    ): Promise<SecretSkeleton>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    createVersionOfSecret(
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        secretId: string,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        value: string,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    ): Promise<VersionOfSecretSkeleton>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    deleteSecret(secretId: string): Promise<SecretSkeleton>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    deleteVersionOfSecret(
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        secretId: string,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        version: string,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    ): Promise<VersionOfSecretSkeleton>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    disableVersionOfSecret(
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        secretId: string,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        version: string,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    ): Promise<VersionOfSecretSkeleton>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    enableVersionOfSecret(
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        secretId: string,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        version: string,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    ): Promise<VersionOfSecretSkeleton>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    exportSecret(
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        secretId: string,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        includeActiveValue?: boolean,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        target?: string,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    ): Promise<SecretsExportInterface>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    exportSecrets(
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        includeActiveValues?: boolean,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        target?: string,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    ): Promise<SecretsExportInterface>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    getSecret(secretId: string): Promise<SecretSkeleton>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    getSecrets(): Promise<SecretSkeleton[]>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    getSecretVersions(secretId: string): Promise<VersionOfSecretSkeleton[]>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    getVersionOfSecret(
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        secretId: string,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        version: string,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    ): Promise<VersionOfSecretSkeleton>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    importSecret(
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        secretId: string,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        importData: SecretsExportInterface,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        includeActiveValue?: boolean,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        source?: string,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    ): Promise<SecretSkeleton>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    importSecrets(
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        importData: SecretsExportInterface,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        includeActiveValues?: boolean,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        source?: string,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    ): Promise<SecretSkeleton[]>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    putSecret(
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        secretId: string,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        value: string,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        description: string,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        encoding?: string,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        useInPlaceholders?: boolean,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    ): Promise<SecretSkeleton>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    readSecret(secretId: string): Promise<SecretSkeleton>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    readSecrets(): Promise<SecretSkeleton[]>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    readSecretValue(
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        secretId: string,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        target?: string,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        decrypt?: boolean,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    ): Promise<any>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    readSecretValues(
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        secretIds: string[],
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        target?: string,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        decrypt?: boolean,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    ): Promise<{ [key: string]: string }>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    readVersionOfSecret(
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        secretId: string,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        version: string,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    ): Promise<VersionOfSecretSkeleton>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    readVersionsOfSecret(secretId: string): Promise<VersionOfSecretSkeleton[]>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    setSecretDescription(secretId: string, description: string): Promise<any>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    setStatusOfVersionOfSecret(
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        secretId: string,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        version: string,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        status: VersionOfSecretStatus,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    ): Promise<VersionOfSecretSkeleton>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    updateSecretDescription(
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        secretId: string,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        description: string,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    ): Promise<any>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                }
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Index

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Methods

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                createSecret +Secret | Frodo Library - v4.0.0-11
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Frodo Library - v4.0.0-11
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Type Alias Secret

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  type Secret = {
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      createNewVersionOfSecret(
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          secretId: string,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          value: string,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      ): Promise<VersionOfSecretSkeleton>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      createSecret(
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          secretId: string,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          value: string,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          description: string,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          encoding?: string,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          useInPlaceholders?: boolean,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      ): Promise<SecretSkeleton>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      createVersionOfSecret(
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          secretId: string,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          value: string,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      ): Promise<VersionOfSecretSkeleton>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      deleteSecret(secretId: string): Promise<SecretSkeleton>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      deleteVersionOfSecret(
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          secretId: string,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          version: string,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      ): Promise<VersionOfSecretSkeleton>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      disableVersionOfSecret(
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          secretId: string,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          version: string,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      ): Promise<VersionOfSecretSkeleton>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      enableVersionOfSecret(
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          secretId: string,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          version: string,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      ): Promise<VersionOfSecretSkeleton>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      exportSecret(
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          secretId: string,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          includeActiveValue?: boolean,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          target?: string,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      ): Promise<SecretsExportInterface>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      exportSecrets(
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          includeActiveValues?: boolean,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          target?: string,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      ): Promise<SecretsExportInterface>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      getSecret(secretId: string): Promise<SecretSkeleton>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      getSecrets(): Promise<SecretSkeleton[]>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      getSecretVersions(secretId: string): Promise<VersionOfSecretSkeleton[]>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      getVersionOfSecret(
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          secretId: string,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          version: string,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      ): Promise<VersionOfSecretSkeleton>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      importSecret(
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          secretId: string,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          importData: SecretsExportInterface,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          includeActiveValue?: boolean,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          source?: string,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      ): Promise<SecretSkeleton>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      importSecrets(
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          importData: SecretsExportInterface,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          includeActiveValues?: boolean,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          source?: string,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      ): Promise<SecretSkeleton[]>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      putSecret(
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          secretId: string,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          value: string,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          description: string,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          encoding?: string,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          useInPlaceholders?: boolean,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      ): Promise<SecretSkeleton>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      readSecret(secretId: string): Promise<SecretSkeleton>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      readSecrets(): Promise<SecretSkeleton[]>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      readSecretValue(
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          secretId: string,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          target?: string,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          decrypt?: boolean,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      ): Promise<any>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      readSecretValues(
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          secretIds: string[],
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          target?: string,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          decrypt?: boolean,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      ): Promise<{ [key: string]: string }>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      readVersionOfSecret(
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          secretId: string,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          version: string,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      ): Promise<VersionOfSecretSkeleton>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      readVersionsOfSecret(secretId: string): Promise<VersionOfSecretSkeleton[]>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      setSecretDescription(secretId: string, description: string): Promise<any>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      setStatusOfVersionOfSecret(
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          secretId: string,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          version: string,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          status: VersionOfSecretStatus,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      ): Promise<VersionOfSecretSkeleton>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      updateSecretDescription(
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          secretId: string,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          description: string,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      ): Promise<any>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  }
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Index

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Methods

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • Optionalencoding: string

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  secret encoding (only generic is supported)

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • OptionaluseInPlaceholders: boolean

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  flag indicating if the secret can be used in placeholders

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • Returns Promise<SecretSkeleton>

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  a promise that resolves to a secret

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • Export secret. The response can be saved to file as is.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • secretId: string

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      secret id/name

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • OptionalincludeActiveValue: boolean

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      include active value of secret (default: false)

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • Optionaltarget: string

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Host URL of target environment to encrypt secret value for

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Returns Promise<SecretsExportInterface>

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Promise resolving to a SecretsExportInterface object.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • Export all secrets

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • OptionalincludeActiveValues: boolean

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      include active values of secrets (default: false)

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • Optionaltarget: string

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Host URL of target environment to encrypt secret values for

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Returns Promise<SecretsExportInterface>

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Promise resolving to an SecretsExportInterface object.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • Import secret by id

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • secretId: string

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      secret id/name

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • importData: SecretsExportInterface

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      import data

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • OptionalincludeActiveValue: boolean

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      include active value of secret (default: false)

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • Optionalsource: string

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Host URL of source environment where the secret was exported from

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Returns Promise<SecretSkeleton>

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    imported secret object

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • Import secrets

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • importData: SecretsExportInterface

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      import data

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • OptionalincludeActiveValues: boolean

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      include active values of secrets (default: false)

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • Optionalsource: string

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Host URL of source environment where the secrets were exported from

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Returns Promise<SecretSkeleton[]>

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    array of imported secret objects

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • Read the value of a secret

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • Read the value of a secret

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • secretId: string

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      secret id/name

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • Optionaltarget: string

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Host URL of target environment to encrypt secret value for

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • Optionaldecrypt: boolean

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      retrieve secret value in the clear (default: false)

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Returns Promise<any>

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    a promise that resolves to the value of the secret

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • Read the values of an array of secrets

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • Read the values of an array of secrets

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • secretIds: string[]

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      secret id/name

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • Optionaltarget: string

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Host URL of target environment to encrypt secret values for

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • Optionaldecrypt: boolean

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      retrieve secret values in the clear (default: false)

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Returns Promise<{ [key: string]: string }>

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    a promise that resolves to a map of secret ids and values

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • Update secret description

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • Update secret description

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • secretId: string

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      secret id/name

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • description: string

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      secret description

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Returns Promise<any>

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    a promise that resolves to an empty string

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Deprecated

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Deprecated

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • Create new secret version

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • secretId: string

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      secret id/name

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • value: string

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      secret value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Returns Promise<VersionOfSecretSkeleton>

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    a promise that resolves to a version object

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    @@ -103,27 +103,27 @@
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    createVersionOfSecret(secretId: string, value: string): Promise<any>
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                     
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  diff --git a/docs/types/Reference.SecretEncodingType.html b/docs/types/Reference.SecretEncodingType.html index 4b4713940..9118fc81e 100644 --- a/docs/types/Reference.SecretEncodingType.html +++ b/docs/types/Reference.SecretEncodingType.html @@ -1,3 +1,3 @@ -SecretEncodingType | Frodo Library - v4.0.0-10
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Frodo Library - v4.0.0-10
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Type Alias SecretEncodingType

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    SecretEncodingType: "generic" | "pem" | "base64hmac" | "base64aes"

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Secret encoding

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    +SecretEncodingType | Frodo Library - v4.0.0-11
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Frodo Library - v4.0.0-11
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Type Alias SecretEncodingType

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      SecretEncodingType: "generic" | "pem" | "base64hmac" | "base64aes"

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Secret encoding

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      diff --git a/docs/types/Reference.SecretSkeleton.html b/docs/types/Reference.SecretSkeleton.html index 9d107391d..e1d380e03 100644 --- a/docs/types/Reference.SecretSkeleton.html +++ b/docs/types/Reference.SecretSkeleton.html @@ -1,2 +1,2 @@ -SecretSkeleton | Frodo Library - v4.0.0-10
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Frodo Library - v4.0.0-10
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Type Alias SecretSkeleton

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        SecretSkeleton: IdObjectSkeletonInterface & {
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            activeValue?: any;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            activeVersion?: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            description: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            encoding: SecretEncodingType;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            lastChangeDate?: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            lastChangedBy?: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            loaded?: boolean;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            loadedVersion?: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            useInPlaceholders: boolean;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        }

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Secret object skeleton

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        +SecretSkeleton | Frodo Library - v4.0.0-11
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Frodo Library - v4.0.0-11
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Type Alias SecretSkeleton

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          SecretSkeleton: IdObjectSkeletonInterface & {
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              activeValue?: any;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              activeVersion?: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              description: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              encoding: SecretEncodingType;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              lastChangeDate?: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              lastChangedBy?: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              loaded?: boolean;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              loadedVersion?: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              useInPlaceholders: boolean;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          }

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Secret object skeleton

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          diff --git a/docs/types/Reference.Service.html b/docs/types/Reference.Service.html index 9c3643873..decb2b1f9 100644 --- a/docs/types/Reference.Service.html +++ b/docs/types/Reference.Service.html @@ -1,4 +1,4 @@ -Service | Frodo Library - v4.0.0-10
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Frodo Library - v4.0.0-10
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Type Alias Service

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            type Service = {
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                createServiceExportTemplate(): ServiceExportInterface;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                deleteFullService(
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    serviceId: string,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    globalConfig?: boolean,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                ): Promise<AmServiceSkeleton>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                deleteFullServices(globalConfig?: boolean): Promise<AmServiceSkeleton[]>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                exportService(
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    serviceId: string,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    globalConfig?: boolean,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                ): Promise<ServiceExportInterface>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                exportServices(globalConfig?: boolean): Promise<ServiceExportInterface>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                getFullServices(globalConfig?: boolean): Promise<FullService[]>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                getListOfServices(globalConfig?: boolean): Promise<AmServiceSkeleton[]>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                importService(
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    serviceId: string,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    importData: ServiceExportInterface,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    options: ServiceImportOptions,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                ): Promise<AmServiceSkeleton>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                importServices(
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    importData: ServiceExportInterface,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    options: ServiceImportOptions,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                ): Promise<AmServiceSkeleton[]>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            }
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Index

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Methods

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            createServiceExportTemplate +Service | Frodo Library - v4.0.0-11
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Frodo Library - v4.0.0-11
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Type Alias Service

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              type Service = {
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  createServiceExportTemplate(): ServiceExportInterface;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  deleteFullService(
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      serviceId: string,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      globalConfig?: boolean,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  ): Promise<AmServiceSkeleton>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  deleteFullServices(globalConfig?: boolean): Promise<AmServiceSkeleton[]>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  exportService(
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      serviceId: string,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      globalConfig?: boolean,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  ): Promise<ServiceExportInterface>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  exportServices(globalConfig?: boolean): Promise<ServiceExportInterface>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  getFullServices(globalConfig?: boolean): Promise<FullService[]>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  getListOfServices(globalConfig?: boolean): Promise<AmServiceSkeleton[]>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  importService(
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      serviceId: string,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      importData: ServiceExportInterface,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      options: ServiceImportOptions,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  ): Promise<AmServiceSkeleton>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  importServices(
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      importData: ServiceExportInterface,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      options: ServiceImportOptions,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  ): Promise<AmServiceSkeleton[]>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              }
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Index

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Methods

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • Deletes the specified service

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Methods

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • Deletes the specified service

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • serviceId: string

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  The service to delete

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • OptionalglobalConfig: boolean

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  true if the global service is the target of the operation, false otherwise. Default: false.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Returns Promise<AmServiceSkeleton>

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • Deletes all services

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Returns Promise<AmServiceSkeleton>

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Returns Promise<AmServiceSkeleton[]>

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Returns Promise<ServiceExportInterface>

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Returns Promise<AmServiceSkeleton[]>

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              diff --git a/docs/types/Reference.ServiceAccount.html b/docs/types/Reference.ServiceAccount.html index 01f33e7cc..501de9cc4 100644 --- a/docs/types/Reference.ServiceAccount.html +++ b/docs/types/Reference.ServiceAccount.html @@ -1,4 +1,4 @@ -ServiceAccount | Frodo Library - v4.0.0-10
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Frodo Library - v4.0.0-10
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Type Alias ServiceAccount

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                type ServiceAccount = {
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    createServiceAccount(
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        name: string,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        description: string,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        accountStatus: "active" | "inactive",
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        scopes: string[],
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        jwks: JwksInterface,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    ): Promise<IdObjectSkeletonInterface>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    getServiceAccount(serviceAccountId: string): Promise<ServiceAccountType>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    isServiceAccountsFeatureAvailable(): Promise<boolean>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                }
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Index

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Methods

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                createServiceAccount +ServiceAccount | Frodo Library - v4.0.0-11
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Frodo Library - v4.0.0-11
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Type Alias ServiceAccount

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  type ServiceAccount = {
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      createServiceAccount(
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          name: string,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          description: string,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          accountStatus: "active" | "inactive",
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          scopes: string[],
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          jwks: JwksInterface,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      ): Promise<IdObjectSkeletonInterface>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      getServiceAccount(serviceAccountId: string): Promise<ServiceAccountType>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      isServiceAccountsFeatureAvailable(): Promise<boolean>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  }
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Index

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Methods

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • Create service account

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    @@ -8,9 +8,9 @@
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • scopes: string[]

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Scopes.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • jwks: JwksInterface

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Java Web Key Set

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Returns Promise<IdObjectSkeletonInterface>

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  A promise resolving to a service account object

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • Check if service accounts are available

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Returns Promise<boolean>

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    true if service accounts are available, false otherwise

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  diff --git a/docs/types/Reference.ServiceAccountType.html b/docs/types/Reference.ServiceAccountType.html index f2b857693..c44c65be9 100644 --- a/docs/types/Reference.ServiceAccountType.html +++ b/docs/types/Reference.ServiceAccountType.html @@ -1 +1 @@ -ServiceAccountType | Frodo Library - v4.0.0-10
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Frodo Library - v4.0.0-10
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Type Alias ServiceAccountType

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    ServiceAccountType: IdObjectSkeletonInterface & {
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        accountStatus: "active" | "inactive";
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        description: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        jwks: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        name: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        scopes: string[];
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    }
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    +ServiceAccountType | Frodo Library - v4.0.0-11
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Frodo Library - v4.0.0-11
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Type Alias ServiceAccountType

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      ServiceAccountType: IdObjectSkeletonInterface & {
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          accountStatus: "active" | "inactive";
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          description: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          jwks: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          name: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          scopes: string[];
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      }
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      diff --git a/docs/types/Reference.Session.html b/docs/types/Reference.Session.html index b39497671..c17490639 100644 --- a/docs/types/Reference.Session.html +++ b/docs/types/Reference.Session.html @@ -1,5 +1,5 @@ -Session | Frodo Library - v4.0.0-10
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Frodo Library - v4.0.0-10
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Type Alias Session

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        type Session = {
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            getSessionInfo(tokenId: string): Promise<SessionInfoType>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        }
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Index

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Methods

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        getSessionInfo +Session | Frodo Library - v4.0.0-11
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Frodo Library - v4.0.0-11
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Type Alias Session

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          type Session = {
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              getSessionInfo(tokenId: string): Promise<SessionInfoType>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          }
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Index

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Methods

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          diff --git a/docs/types/Reference.SessionInfoType.html b/docs/types/Reference.SessionInfoType.html index 289c04176..f951b8742 100644 --- a/docs/types/Reference.SessionInfoType.html +++ b/docs/types/Reference.SessionInfoType.html @@ -1,8 +1,8 @@ -SessionInfoType | Frodo Library - v4.0.0-10
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Frodo Library - v4.0.0-10
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Type Alias SessionInfoType

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            type SessionInfoType = {
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                latestAccessTime: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                maxIdleExpirationTime: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                maxSessionExpirationTime: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                properties: { AMCtxId: string; [k: string]: string };
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                realm: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                universalId: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                username: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            }
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Index

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Properties

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            latestAccessTime +SessionInfoType | Frodo Library - v4.0.0-11
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Frodo Library - v4.0.0-11
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Type Alias SessionInfoType

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              type SessionInfoType = {
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  latestAccessTime: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  maxIdleExpirationTime: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  maxSessionExpirationTime: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  properties: { AMCtxId: string; [k: string]: string };
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  realm: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  universalId: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  username: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              }
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Index

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Properties

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              latestAccessTime: string
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              maxIdleExpirationTime: string
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              maxSessionExpirationTime: string
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              properties: { AMCtxId: string; [k: string]: string }
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              realm: string
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              universalId: string
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              username: string
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Properties

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              latestAccessTime: string
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              maxIdleExpirationTime: string
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              maxSessionExpirationTime: string
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              properties: { AMCtxId: string; [k: string]: string }
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              realm: string
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              universalId: string
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              username: string
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              diff --git a/docs/types/Reference.SocialIdpSkeleton.html b/docs/types/Reference.SocialIdpSkeleton.html index 9e3da0aec..e42905ba9 100644 --- a/docs/types/Reference.SocialIdpSkeleton.html +++ b/docs/types/Reference.SocialIdpSkeleton.html @@ -1 +1 @@ -SocialIdpSkeleton | Frodo Library - v4.0.0-10
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Frodo Library - v4.0.0-10
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Type Alias SocialIdpSkeleton

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                SocialIdpSkeleton: AmConfigEntityInterface & {
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    authenticationIdKey: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    authorizationEndpoint: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    clientAuthenticationMethod: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    clientId: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    clientSecret?: string | null;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    clientSecretLabelIdentifier?: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    enabled: boolean;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    introspectEndpoint?: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    issuerComparisonCheckType: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    jwksUriEndpoint?: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    jwtEncryptionAlgorithm: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    jwtEncryptionMethod: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    jwtSigningAlgorithm: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    pkceMethod: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    privateKeyJwtExpTime: number;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    redirectAfterFormPostURI?: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    redirectURI: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    responseMode: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    revocationCheckOptions: string[];
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    scopeDelimiter: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    scopes: string[];
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    tokenEndpoint: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    transform: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    uiConfig: Record<string, string>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    useCustomTrustStore: boolean;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    userInfoEndpoint?: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                }
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                +SocialIdpSkeleton | Frodo Library - v4.0.0-11
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Frodo Library - v4.0.0-11
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Type Alias SocialIdpSkeleton

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  SocialIdpSkeleton: AmConfigEntityInterface & {
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      authenticationIdKey: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      authorizationEndpoint: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      clientAuthenticationMethod: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      clientId: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      clientSecret?: string | null;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      clientSecretLabelIdentifier?: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      enabled: boolean;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      introspectEndpoint?: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      issuerComparisonCheckType: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      jwksUriEndpoint?: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      jwtEncryptionAlgorithm: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      jwtEncryptionMethod: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      jwtSigningAlgorithm: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      pkceMethod: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      privateKeyJwtExpTime: number;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      redirectAfterFormPostURI?: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      redirectURI: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      responseMode: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      revocationCheckOptions: string[];
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      scopeDelimiter: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      scopes: string[];
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      tokenEndpoint: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      transform: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      uiConfig: Record<string, string>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      useCustomTrustStore: boolean;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      userInfoEndpoint?: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  }
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  diff --git a/docs/types/Reference.Startup.html b/docs/types/Reference.Startup.html index 10123fdda..c19e0871c 100644 --- a/docs/types/Reference.Startup.html +++ b/docs/types/Reference.Startup.html @@ -1,9 +1,9 @@ -Startup | Frodo Library - v4.0.0-10
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Frodo Library - v4.0.0-10
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Type Alias Startup

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    type Startup = {
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        applyUpdates(wait: boolean, timeout?: number): Promise<boolean>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        checkForUpdates(): Promise<Updates>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    }
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Index

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Methods

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    applyUpdates +Startup | Frodo Library - v4.0.0-11
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Frodo Library - v4.0.0-11
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Type Alias Startup

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      type Startup = {
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          applyUpdates(wait: boolean, timeout?: number): Promise<boolean>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          checkForUpdates(): Promise<Updates>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      }
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Index

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Methods

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • Apply updates

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • wait: boolean

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          wait for the operation to complete or not

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • Optionaltimeout: number

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          timeout in milliseconds

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Returns Promise<boolean>

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        true if successful, false otherwise

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • Check for updates that need applying

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Returns Promise<Updates>

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        true if there are updates that need to be applied, false otherwise

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      diff --git a/docs/types/Reference.State.html b/docs/types/Reference.State.html index f773c9618..90e7d975c 100644 --- a/docs/types/Reference.State.html +++ b/docs/types/Reference.State.html @@ -1,4 +1,4 @@ -State | Frodo Library - v4.0.0-10
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Frodo Library - v4.0.0-10
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Type Alias State

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        type State = {
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            getAdminClientId(): string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            getAdminClientRedirectUri(): string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            getAlias(): string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            getAllowInsecureConnection(): boolean;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            getAmsterPrivateKey(): string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            getAmVersion(): string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            getAuthenticationHeaderOverrides(): Record<string, string>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            getAuthenticationService(): string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            getAutoRefreshTimer(): Timeout;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            getAxiosRetryConfig(): IAxiosRetryConfig;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            getBearerToken(): string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            getBearerTokenMeta(): AccessTokenMetaType;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            getConnectionProfilesPath(): string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            getCookieName(): string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            getCookieValue(): string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            getCreateProgressHandler(): (
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                type: ProgressIndicatorType,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                total?: number,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                message?: string,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            ) => string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            getCurlirize(): boolean;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            getCurlirizeHandler(): (message: string) => void;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            getDebug(): boolean;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            getDebugHandler(): (message: string | object) => void;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            getDeploymentType(): string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            getDirectory(): string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            getErrorHandler(): (error: Error, message?: string) => void;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            getFeatures(): FeatureInterface[];
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            getFrodoVersion(): string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            getHost(): string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            getIdmHost(): string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            getIsIGA(): boolean;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            getLogApiKey(): string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            getLogApiSecret(): string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            getMasterKeyPath(): string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            getOutputFile(): string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            getPassword(): string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            getPrintHandler(): (
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                message: string | object,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                type?: string,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                newline?: boolean,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            ) => void;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            getRealm(): string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            getServiceAccountId(): string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            getServiceAccountJwk(): JwkRsa;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            getServiceAccountScope(): string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            getState(): StateInterface;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            getStopProgressHandler(): (
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                id: string,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                message: string,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                status?: ProgressIndicatorStatusType,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            ) => void;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            getTenant(): string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            getTokenCachePath(): string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            getUpdateProgressHandler(): (id: string, message: string) => void;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            getUseBearerTokenForAmApis(): boolean;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            getUseRealmPrefixOnManagedObjects(): boolean;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            getUsername(): string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            getUserSessionTokenMeta(): UserSessionMetaType;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            getUseTokenCache(): boolean;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            getVerbose(): boolean;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            getVerboseHandler(): (message: string | object) => void;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            reset(): void;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            setAdminClientId(type: string): void;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            setAdminClientRedirectUri(type: string): void;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            setAlias(alias: string): void;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            setAllowInsecureConnection(allowInsecureConnection: boolean): void;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            setAmsterPrivateKey(key: string): void;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            setAmVersion(version: string): void;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            setAuthenticationHeaderOverrides(overrides: Record<string, string>): void;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            setAuthenticationService(service: string): void;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            setAutoRefreshTimer(timer: Timeout): void;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            setAxiosRetryConfig(axiosRetryConfig: IAxiosRetryConfig): void;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            setAxiosRetryStrategy(strategy: RetryStrategy): void;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            setBearerTokenMeta(token: AccessTokenMetaType): void;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            setConnectionProfilesPath(path: string): void;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            setCookieName(name: string): void;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            setCreateProgressHandler(
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                handler: (
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    type: ProgressIndicatorType,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    total?: number,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    message?: string,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                ) => string,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            ): void;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            setCurlirize(curlirize: boolean): void;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            setCurlirizeHandler(handler: (message: string) => void): void;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            setDebug(debug: boolean): void;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            setDebugHandler(handler: (message: string | object) => void): void;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            setDeploymentType(type: string): void;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            setDirectory(directory: string): void;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            setErrorHandler(handler: (error: Error, message?: string) => void): void;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            setFeatures(features: FeatureInterface[]): void;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            setFrodoVersion(version: string): void;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            setHost(host: string): void;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            setIdmHost(host: string): void;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            setIsIGA(isIGA: boolean): void;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            setLogApiKey(key: string): void;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            setLogApiSecret(secret: string): void;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            setMasterKeyPath(path: string): void;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            setOutputFile(file: string): void;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            setPassword(password: string): void;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            setPrintHandler(
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                handler: (
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    message: string | object,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    type?: string,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    newline?: boolean,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                ) => void,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            ): void;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            setRealm(realm: string): void;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            setServiceAccountId(uuid: string): void;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            setServiceAccountJwk(jwk: JwkRsa): void;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            setServiceAccountScope(scope: string): void;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            setStopProgressHandler(
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                handler: (
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    id: string,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    message: string,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    status?: ProgressIndicatorStatusType,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                ) => void,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            ): void;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            setTenant(tenant: string): void;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            setTokenCachePath(path: string): void;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            setUpdateProgressHandler(
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                handler: (id: string, message: string) => void,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            ): void;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            setUseBearerTokenForAmApis(useBearerTokenForAmApis: boolean): void;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            setUseRealmPrefixOnManagedObjects(
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                useRealmPrefixOnManagedObjects: boolean,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            ): void;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            setUsername(username: string): void;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            setUserSessionTokenMeta(value: UserSessionMetaType): void;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            setUseTokenCache(useTokenCache: boolean): void;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            setVerbose(verbose: boolean): void;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            setVerboseHandler(handler: (message: string | object) => void): void;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        }
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Index

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Methods

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        getAdminClientId +State | Frodo Library - v4.0.0-11
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Frodo Library - v4.0.0-11
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Type Alias State

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          type State = {
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              getAdminClientId(): string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              getAdminClientRedirectUri(): string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              getAlias(): string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              getAllowInsecureConnection(): boolean;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              getAmsterPrivateKey(): string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              getAmVersion(): string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              getAuthenticationHeaderOverrides(): Record<string, string>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              getAuthenticationService(): string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              getAutoRefreshTimer(): Timeout;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              getAxiosRetryConfig(): IAxiosRetryConfig;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              getBearerToken(): string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              getBearerTokenMeta(): AccessTokenMetaType;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              getConnectionProfilesPath(): string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              getCookieName(): string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              getCookieValue(): string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              getCreateProgressHandler(): (
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  type: ProgressIndicatorType,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  total?: number,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  message?: string,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              ) => string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              getCurlirize(): boolean;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              getCurlirizeHandler(): (message: string) => void;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              getDebug(): boolean;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              getDebugHandler(): (message: string | object) => void;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              getDeploymentType(): string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              getDirectory(): string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              getErrorHandler(): (error: Error, message?: string) => void;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              getFeatures(): FeatureInterface[];
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              getFrodoVersion(): string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              getHost(): string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              getIdmHost(): string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              getIsIGA(): boolean;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              getLogApiKey(): string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              getLogApiSecret(): string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              getMasterKeyPath(): string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              getOutputFile(): string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              getPassword(): string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              getPrintHandler(): (
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  message: string | object,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  type?: string,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  newline?: boolean,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              ) => void;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              getRealm(): string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              getServiceAccountId(): string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              getServiceAccountJwk(): JwkRsa;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              getServiceAccountScope(): string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              getState(): StateInterface;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              getStopProgressHandler(): (
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  id: string,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  message: string,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  status?: ProgressIndicatorStatusType,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              ) => void;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              getTenant(): string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              getTokenCachePath(): string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              getUpdateProgressHandler(): (id: string, message: string) => void;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              getUseBearerTokenForAmApis(): boolean;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              getUseRealmPrefixOnManagedObjects(): boolean;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              getUsername(): string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              getUserSessionTokenMeta(): UserSessionMetaType;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              getUseTokenCache(): boolean;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              getVerbose(): boolean;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              getVerboseHandler(): (message: string | object) => void;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              reset(): void;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              setAdminClientId(type: string): void;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              setAdminClientRedirectUri(type: string): void;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              setAlias(alias: string): void;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              setAllowInsecureConnection(allowInsecureConnection: boolean): void;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              setAmsterPrivateKey(key: string): void;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              setAmVersion(version: string): void;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              setAuthenticationHeaderOverrides(overrides: Record<string, string>): void;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              setAuthenticationService(service: string): void;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              setAutoRefreshTimer(timer: Timeout): void;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              setAxiosRetryConfig(axiosRetryConfig: IAxiosRetryConfig): void;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              setAxiosRetryStrategy(strategy: RetryStrategy): void;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              setBearerTokenMeta(token: AccessTokenMetaType): void;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              setConnectionProfilesPath(path: string): void;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              setCookieName(name: string): void;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              setCreateProgressHandler(
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  handler: (
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      type: ProgressIndicatorType,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      total?: number,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      message?: string,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  ) => string,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              ): void;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              setCurlirize(curlirize: boolean): void;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              setCurlirizeHandler(handler: (message: string) => void): void;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              setDebug(debug: boolean): void;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              setDebugHandler(handler: (message: string | object) => void): void;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              setDeploymentType(type: string): void;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              setDirectory(directory: string): void;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              setErrorHandler(handler: (error: Error, message?: string) => void): void;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              setFeatures(features: FeatureInterface[]): void;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              setFrodoVersion(version: string): void;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              setHost(host: string): void;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              setIdmHost(host: string): void;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              setIsIGA(isIGA: boolean): void;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              setLogApiKey(key: string): void;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              setLogApiSecret(secret: string): void;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              setMasterKeyPath(path: string): void;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              setOutputFile(file: string): void;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              setPassword(password: string): void;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              setPrintHandler(
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  handler: (
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      message: string | object,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      type?: string,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      newline?: boolean,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  ) => void,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              ): void;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              setRealm(realm: string): void;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              setServiceAccountId(uuid: string): void;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              setServiceAccountJwk(jwk: JwkRsa): void;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              setServiceAccountScope(scope: string): void;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              setStopProgressHandler(
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  handler: (
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      id: string,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      message: string,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      status?: ProgressIndicatorStatusType,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  ) => void,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              ): void;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              setTenant(tenant: string): void;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              setTokenCachePath(path: string): void;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              setUpdateProgressHandler(
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  handler: (id: string, message: string) => void,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              ): void;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              setUseBearerTokenForAmApis(useBearerTokenForAmApis: boolean): void;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              setUseRealmPrefixOnManagedObjects(
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  useRealmPrefixOnManagedObjects: boolean,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              ): void;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              setUsername(username: string): void;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              setUserSessionTokenMeta(value: UserSessionMetaType): void;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              setUseTokenCache(useTokenCache: boolean): void;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              setVerbose(verbose: boolean): void;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              setVerboseHandler(handler: (message: string | object) => void): void;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          }
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Index

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Methods

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • Returns Record<string, string>

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • Returns IAxiosRetryConfig

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • Returns (message: string) => void

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • Returns (message: string | object) => void

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • Returns (error: Error, message?: string) => void

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • Get the AM host base URL

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Methods

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • Returns Record<string, string>

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • Returns IAxiosRetryConfig

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • Returns (message: string) => void

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • Returns (message: string | object) => void

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • Returns (error: Error, message?: string) => void

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • Get the AM host base URL

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Returns string

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            the AM host base URL

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • Get the IDM host base URL

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Returns string

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            the IDM host base URL

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • Returns (message: string | object, type?: string, newline?: boolean) => void

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • Returns (message: string | object, type?: string, newline?: boolean) => void

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • Returns string

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            since v0.17.0 use getHost instead

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • Returns (id: string, message: string) => void

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • Returns (message: string | object) => void

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • type: string

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Returns void

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • type: string

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Returns void

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • alias: string

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Returns void

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • allowInsecureConnection: boolean

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Returns void

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • key: string

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Returns void

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • version: string

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Returns void

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • overrides: Record<string, string>

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Returns void

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • service: string

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Returns void

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • timer: Timeout

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Returns void

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • axiosRetryConfig: IAxiosRetryConfig

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Returns void

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • path: string

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Returns void

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • name: string

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Returns void

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Returns void

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • curlirize: boolean

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Returns void

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • handler: (message: string) => void

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Returns void

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • debug: boolean

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Returns void

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • handler: (message: string | object) => void

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Returns void

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • type: string

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Returns void

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • directory: string

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Returns void

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • handler: (error: Error, message?: string) => void

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Returns void

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • version: string

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Returns void

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • Returns string

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            since v0.17.0 use getHost instead

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • Returns (id: string, message: string) => void

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • Returns (message: string | object) => void

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • type: string

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Returns void

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • type: string

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Returns void

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • alias: string

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Returns void

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • allowInsecureConnection: boolean

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Returns void

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • key: string

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Returns void

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • version: string

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Returns void

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • overrides: Record<string, string>

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Returns void

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • service: string

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Returns void

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • timer: Timeout

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Returns void

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • axiosRetryConfig: IAxiosRetryConfig

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Returns void

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • path: string

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Returns void

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • name: string

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Returns void

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Returns void

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • curlirize: boolean

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Returns void

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • handler: (message: string) => void

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Returns void

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • debug: boolean

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Returns void

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • handler: (message: string | object) => void

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Returns void

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • type: string

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Returns void

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • directory: string

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Returns void

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • handler: (error: Error, message?: string) => void

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Returns void

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • version: string

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Returns void

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • Set the AM host base URL

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • host: string

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Access Management base URL, e.g.: https://cdk.iam.example.com/am. To use a connection profile, just specify a unique substring or alias.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Returns void

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • Set the IDM host base URL

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Returns void

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Returns void

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          diff --git a/docs/types/Reference.Theme.html b/docs/types/Reference.Theme.html index fd5329b7f..8601fcc7e 100644 --- a/docs/types/Reference.Theme.html +++ b/docs/types/Reference.Theme.html @@ -1,4 +1,4 @@ -Theme | Frodo Library - v4.0.0-10
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Frodo Library - v4.0.0-10
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Type Alias Theme

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            type Theme = {
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                createTheme(
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    themeData: ThemeSkeleton,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    themeId?: string,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    realm?: string,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                ): Promise<ThemeSkeleton>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                createThemeExportTemplate(): ThemeExportInterface;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                deleteTheme(themeId: string, realm?: string): Promise<ThemeSkeleton>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                deleteThemeByName(
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    themeName: string,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    realm?: string,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                ): Promise<ThemeSkeleton>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                deleteThemes(realm?: string): Promise<ThemeSkeleton[]>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                exportThemes(): Promise<ThemeExportInterface>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                getTheme(themeId: string, realm?: string): Promise<ThemeSkeleton>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                getThemeByName(themeName: string, realm?: string): Promise<ThemeSkeleton>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                getThemes(): Promise<ThemeSkeleton[]>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                importThemes(importData: ThemeExportInterface): Promise<ThemeSkeleton[]>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                putTheme(
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    themeId: string,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    themeData: ThemeSkeleton,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    realm?: string,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                ): Promise<ThemeSkeleton>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                putThemeByName(
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    themeName: string,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    themeData: ThemeSkeleton,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    realm?: string,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                ): Promise<ThemeSkeleton>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                putThemes(
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    themeMap: Record<string, ThemeSkeleton>,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                ): Promise<Record<string, ThemeSkeleton>>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                readTheme(themeId: string, realm?: string): Promise<ThemeSkeleton>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                readThemeByName(themeName: string, realm?: string): Promise<ThemeSkeleton>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                readThemes(): Promise<ThemeSkeleton[]>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                updateTheme(
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    themeId: string,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    themeData: ThemeSkeleton,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    realm?: string,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                ): Promise<ThemeSkeleton>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                updateThemeByName(
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    themeName: string,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    themeData: ThemeSkeleton,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    realm?: string,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                ): Promise<ThemeSkeleton>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                updateThemes(
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    themeMap: Record<string, ThemeSkeleton>,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                ): Promise<Record<string, ThemeSkeleton>>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            }
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Index

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Methods

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            createTheme +Theme | Frodo Library - v4.0.0-11
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Frodo Library - v4.0.0-11
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Type Alias Theme

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              type Theme = {
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  createTheme(
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      themeData: ThemeSkeleton,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      themeId?: string,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      realm?: string,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  ): Promise<ThemeSkeleton>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  createThemeExportTemplate(): ThemeExportInterface;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  deleteTheme(themeId: string, realm?: string): Promise<ThemeSkeleton>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  deleteThemeByName(
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      themeName: string,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      realm?: string,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  ): Promise<ThemeSkeleton>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  deleteThemes(realm?: string): Promise<ThemeSkeleton[]>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  exportThemes(): Promise<ThemeExportInterface>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  getTheme(themeId: string, realm?: string): Promise<ThemeSkeleton>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  getThemeByName(themeName: string, realm?: string): Promise<ThemeSkeleton>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  getThemes(): Promise<ThemeSkeleton[]>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  importThemes(importData: ThemeExportInterface): Promise<ThemeSkeleton[]>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  putTheme(
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      themeId: string,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      themeData: ThemeSkeleton,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      realm?: string,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  ): Promise<ThemeSkeleton>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  putThemeByName(
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      themeName: string,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      themeData: ThemeSkeleton,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      realm?: string,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  ): Promise<ThemeSkeleton>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  putThemes(
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      themeMap: Record<string, ThemeSkeleton>,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  ): Promise<Record<string, ThemeSkeleton>>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  readTheme(themeId: string, realm?: string): Promise<ThemeSkeleton>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  readThemeByName(themeName: string, realm?: string): Promise<ThemeSkeleton>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  readThemes(): Promise<ThemeSkeleton[]>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  updateTheme(
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      themeId: string,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      themeData: ThemeSkeleton,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      realm?: string,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  ): Promise<ThemeSkeleton>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  updateThemeByName(
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      themeName: string,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      themeData: ThemeSkeleton,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      realm?: string,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  ): Promise<ThemeSkeleton>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  updateThemes(
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      themeMap: Record<string, ThemeSkeleton>,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  ): Promise<Record<string, ThemeSkeleton>>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              }
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Index

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Methods

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • OptionalthemeId: string

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              theme id

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • Optionalrealm: string

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              realm name

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • Returns Promise<ThemeSkeleton>

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              a promise that resolves to a theme object

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • Delete theme by id

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • themeId: string

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  theme id

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • Optionalrealm: string

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  realm name

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Returns Promise<ThemeSkeleton>

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                a promise that resolves to a themes object

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • Delete theme by name

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • themeName: string

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  theme name

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • Optionalrealm: string

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  realm name

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Returns Promise<ThemeSkeleton>

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                a promise that resolves to a themes object

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • Read theme by id

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • themeId: string

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  theme id

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • Optionalrealm: string

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  realm name

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Returns Promise<ThemeSkeleton>

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                a promise that resolves to a theme object

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • Read theme by name

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • themeName: string

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  theme name

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • Optionalrealm: string

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  realm name

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Returns Promise<ThemeSkeleton>

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                a promise that resolves to a theme object

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • Update theme by name

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • themeName: string

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  theme name

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • themeData: ThemeSkeleton

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  theme object

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • Optionalrealm: string

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  realm name

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Returns Promise<ThemeSkeleton>

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                a promise that resolves to a theme object

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Deprecated

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Deprecated

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • Get theme by id

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • themeId: string

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  theme id

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • Optionalrealm: string

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  realm name

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Returns Promise<ThemeSkeleton>

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                a promise that resolves to a theme object

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                @@ -70,7 +70,7 @@
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                readTheme(themeId: string, realm?: string): Promise<ThemeSkeleton>
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                 
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              diff --git a/docs/types/Reference.ThemeSkeleton.html b/docs/types/Reference.ThemeSkeleton.html index 98688cbc5..27e920b08 100644 --- a/docs/types/Reference.ThemeSkeleton.html +++ b/docs/types/Reference.ThemeSkeleton.html @@ -1 +1 @@ -ThemeSkeleton | Frodo Library - v4.0.0-10
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Frodo Library - v4.0.0-10
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Type Alias ThemeSkeleton

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                ThemeSkeleton: IdObjectSkeletonInterface & {
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    isDefault: boolean;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    linkedTrees: string[];
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    name: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                }
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                +ThemeSkeleton | Frodo Library - v4.0.0-11
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Frodo Library - v4.0.0-11
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Type Alias ThemeSkeleton

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  ThemeSkeleton: IdObjectSkeletonInterface & {
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      isDefault: boolean;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      linkedTrees: string[];
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      name: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  }
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  diff --git a/docs/types/Reference.TokenCache.html b/docs/types/Reference.TokenCache.html index 129654d14..7e1a5a3ce 100644 --- a/docs/types/Reference.TokenCache.html +++ b/docs/types/Reference.TokenCache.html @@ -1,4 +1,4 @@ -TokenCache | Frodo Library - v4.0.0-10
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Frodo Library - v4.0.0-10
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Type Alias TokenCache

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    type TokenCache = {
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        flush(): boolean;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        getTokenCachePath(): string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        hasSaBearerToken(): Promise<boolean>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        hasToken(tokenType: tokenType): Promise<boolean>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        hasUserBearerToken(): Promise<boolean>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        hasUserSessionToken(): Promise<boolean>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        initTokenCache(): void;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        purge(): TokenCacheInterface;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        readSaBearerToken(): Promise<AccessTokenMetaType>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        readToken(
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            tokenType: tokenType,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        ): Promise<AccessTokenMetaType | UserSessionMetaType>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        readUserBearerToken(): Promise<AccessTokenMetaType>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        readUserSessionToken(): Promise<UserSessionMetaType>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        saveSaBearerToken(token: AccessTokenMetaType): Promise<boolean>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        saveUserBearerToken(token: AccessTokenMetaType): Promise<boolean>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        saveUserSessionToken(token: UserSessionMetaType): Promise<boolean>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    }
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Index

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Methods

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    flush +TokenCache | Frodo Library - v4.0.0-11
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Frodo Library - v4.0.0-11
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Type Alias TokenCache

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      type TokenCache = {
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          flush(): boolean;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          getTokenCachePath(): string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          hasSaBearerToken(): Promise<boolean>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          hasToken(tokenType: tokenType): Promise<boolean>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          hasUserBearerToken(): Promise<boolean>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          hasUserSessionToken(): Promise<boolean>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          initTokenCache(): void;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          purge(): TokenCacheInterface;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          readSaBearerToken(): Promise<AccessTokenMetaType>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          readToken(
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              tokenType: tokenType,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          ): Promise<AccessTokenMetaType | UserSessionMetaType>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          readUserBearerToken(): Promise<AccessTokenMetaType>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          readUserSessionToken(): Promise<UserSessionMetaType>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          saveSaBearerToken(token: AccessTokenMetaType): Promise<boolean>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          saveUserBearerToken(token: AccessTokenMetaType): Promise<boolean>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          saveUserSessionToken(token: UserSessionMetaType): Promise<boolean>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      }
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Index

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Methods

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • Flush cache

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Returns boolean

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        true if the operation succeeded, false otherwise

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • Get connection profiles file name

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Returns string

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        connection profiles file name

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • Check if there are suitable service account bearer tokens in the cache

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • Check if there are suitable service account bearer tokens in the cache

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Returns Promise<boolean>

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        true if tokens found in cache, false otherwise

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • Check if there are suitable tokens in the cache

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Returns Promise<boolean>

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        true if tokens found in cache, false otherwise

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • Check if there are suitable user bearer tokens in the cache

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • Check if there are suitable user bearer tokens in the cache

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Returns Promise<boolean>

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        true if tokens found in cache, false otherwise

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • Check if there are suitable user session tokens in the cache

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • Check if there are suitable user session tokens in the cache

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Returns Promise<boolean>

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        true if tokens found in cache, false otherwise

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • Initialize token cache

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        This method is called from app.ts and runs before any of the message handlers are registered. Therefore none of the Console message functions will produce any output.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Returns void

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      diff --git a/docs/types/Reference.TokenInfoResponseType.html b/docs/types/Reference.TokenInfoResponseType.html index 793dfe7d7..bacb67881 100644 --- a/docs/types/Reference.TokenInfoResponseType.html +++ b/docs/types/Reference.TokenInfoResponseType.html @@ -1,4 +1,4 @@ -TokenInfoResponseType | Frodo Library - v4.0.0-10
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Frodo Library - v4.0.0-10
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Type Alias TokenInfoResponseType

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        type TokenInfoResponseType = {
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            access_token: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            aud: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            auditTrackingId: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            auth_time: number;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            authGrantId: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            cts: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            exp: number;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            expires_in: number;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            grant_type: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            iat: number;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            iss: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            jti: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            nbf: number;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            realm: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            scope: string[];
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            sessionToken?: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            sub: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            subname: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            token_type: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            tokenName: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            [k: string]: string | number | string[];
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        }

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Indexable

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • [k: string]: string | number | string[]
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Index

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Properties

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        access_token +TokenInfoResponseType | Frodo Library - v4.0.0-11
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Frodo Library - v4.0.0-11
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Type Alias TokenInfoResponseType

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          type TokenInfoResponseType = {
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              access_token: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              aud: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              auditTrackingId: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              auth_time: number;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              authGrantId: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              cts: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              exp: number;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              expires_in: number;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              grant_type: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              iat: number;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              iss: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              jti: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              nbf: number;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              realm: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              scope: string[];
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              sessionToken?: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              sub: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              subname: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              token_type: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              tokenName: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              [k: string]: string | number | string[];
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          }

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Indexable

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • [k: string]: string | number | string[]
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Index

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Properties

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          access_token: string
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          aud: string
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          auditTrackingId: string
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          auth_time: number
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          authGrantId: string
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          cts: string
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          exp: number
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          expires_in: number
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          grant_type: string
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          iat: number
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          iss: string
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          jti: string
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          nbf: number
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          realm: string
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          scope: string[]
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          sessionToken?: string
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          sub: string
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          subname: string
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          token_type: string
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          tokenName: string
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Properties

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          access_token: string
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          aud: string
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          auditTrackingId: string
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          auth_time: number
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          authGrantId: string
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          cts: string
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          exp: number
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          expires_in: number
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          grant_type: string
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          iat: number
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          iss: string
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          jti: string
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          nbf: number
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          realm: string
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          scope: string[]
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          sessionToken?: string
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          sub: string
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          subname: string
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          token_type: string
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          tokenName: string
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          diff --git a/docs/types/Reference.Tokens.html b/docs/types/Reference.Tokens.html index 5de05af4e..d17d4b5f5 100644 --- a/docs/types/Reference.Tokens.html +++ b/docs/types/Reference.Tokens.html @@ -1,6 +1,6 @@ -Tokens | Frodo Library - v4.0.0-10
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Frodo Library - v4.0.0-10
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Type Alias Tokens

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            type Tokens = {
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                bearerToken?: AccessTokenMetaType;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                host?: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                realm?: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                subject?: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                userSessionToken?: UserSessionMetaType;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            }
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Index

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Properties

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            bearerToken? +Tokens | Frodo Library - v4.0.0-11
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Frodo Library - v4.0.0-11
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Type Alias Tokens

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              type Tokens = {
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  bearerToken?: AccessTokenMetaType;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  host?: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  realm?: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  subject?: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  userSessionToken?: UserSessionMetaType;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              }
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Index

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Properties

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              bearerToken?: AccessTokenMetaType
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              host?: string
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              realm?: string
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              subject?: string
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              userSessionToken?: UserSessionMetaType
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Properties

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              bearerToken?: AccessTokenMetaType
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              host?: string
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              realm?: string
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              subject?: string
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              userSessionToken?: UserSessionMetaType
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              diff --git a/docs/types/Reference.TreeSkeleton.html b/docs/types/Reference.TreeSkeleton.html index c29fb441d..b841df337 100644 --- a/docs/types/Reference.TreeSkeleton.html +++ b/docs/types/Reference.TreeSkeleton.html @@ -1 +1 @@ -TreeSkeleton | Frodo Library - v4.0.0-10
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Frodo Library - v4.0.0-10
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Type Alias TreeSkeleton

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                TreeSkeleton: IdObjectSkeletonInterface & {
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    enabled?: boolean;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    entryNodeId: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    identityResource?: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    innerTreeOnly?: boolean;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    nodes: Record<string, NodeRefSkeletonInterface>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    uiConfig?: UiConfigInterface;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                }
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                +TreeSkeleton | Frodo Library - v4.0.0-11
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Frodo Library - v4.0.0-11
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Type Alias TreeSkeleton

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  TreeSkeleton: IdObjectSkeletonInterface & {
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      enabled?: boolean;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      entryNodeId: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      identityResource?: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      innerTreeOnly?: boolean;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      nodes: Record<string, NodeRefSkeletonInterface>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      uiConfig?: UiConfigInterface;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  }
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  diff --git a/docs/types/Reference.UserSessionMetaType.html b/docs/types/Reference.UserSessionMetaType.html index b2d6fb315..72b605bbc 100644 --- a/docs/types/Reference.UserSessionMetaType.html +++ b/docs/types/Reference.UserSessionMetaType.html @@ -1 +1 @@ -UserSessionMetaType | Frodo Library - v4.0.0-10
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Frodo Library - v4.0.0-10
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Type Alias UserSessionMetaType

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    UserSessionMetaType: AuthenticateSuccessResponse & {
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        expires: number;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        from_cache?: boolean;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    }
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    +UserSessionMetaType | Frodo Library - v4.0.0-11
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Frodo Library - v4.0.0-11
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Type Alias UserSessionMetaType

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      UserSessionMetaType: AuthenticateSuccessResponse & {
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          expires: number;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          from_cache?: boolean;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      }
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      diff --git a/docs/types/Reference.Variable.html b/docs/types/Reference.Variable.html index 5fb400ae0..f6e7a34d5 100644 --- a/docs/types/Reference.Variable.html +++ b/docs/types/Reference.Variable.html @@ -1,4 +1,4 @@ -Variable | Frodo Library - v4.0.0-10
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Frodo Library - v4.0.0-10
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Type Alias Variable

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        type Variable = {
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            createVariable(
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                variableId: string,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                value: string,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                description: string,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                expressionType?: VariableExpressionType,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                noEncode?: boolean,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            ): Promise<VariableSkeleton>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            deleteVariable(variableId: string): Promise<VariableSkeleton>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            exportVariable(
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                variableId: string,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                noDecode?: boolean,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            ): Promise<VariablesExportInterface>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            exportVariables(noDecode?: boolean): Promise<VariablesExportInterface>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            getVariable(variableId: string): Promise<VariableSkeleton>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            getVariables(): Promise<VariableSkeleton[]>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            importVariable(
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                variableId: string,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                importData: VariablesExportInterface,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            ): Promise<VariableSkeleton>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            importVariables(
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                importData: VariablesExportInterface,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            ): Promise<VariableSkeleton[]>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            putVariable(
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                variableId: string,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                valueBase64: string,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                description: string,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                expressionType?: VariableExpressionType,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            ): Promise<VariableSkeleton>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            readVariable(
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                variableId: string,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                noDecode?: boolean,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            ): Promise<VariableSkeleton>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            readVariables(noDecode?: boolean): Promise<VariableSkeleton[]>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            resolveVariable(
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                input: string,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                variables: Record<string, VariableSkeleton>,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            ): Promise<string>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            setVariableDescription(
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                variableId: string,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                description: string,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            ): Promise<any>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            updateVariable(
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                variableId: string,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                value: string,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                description: string,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                expressionType?: VariableExpressionType,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                noEncode?: boolean,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            ): Promise<VariableSkeleton>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            updateVariableDescription(
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                variableId: string,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                description: string,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            ): Promise<VariableSkeleton>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        }
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Index

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Methods

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        createVariable +Variable | Frodo Library - v4.0.0-11
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Frodo Library - v4.0.0-11
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Type Alias Variable

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          type Variable = {
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              createVariable(
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  variableId: string,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  value: string,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  description: string,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  expressionType?: VariableExpressionType,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  noEncode?: boolean,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              ): Promise<VariableSkeleton>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              deleteVariable(variableId: string): Promise<VariableSkeleton>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              exportVariable(
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  variableId: string,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  noDecode?: boolean,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              ): Promise<VariablesExportInterface>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              exportVariables(noDecode?: boolean): Promise<VariablesExportInterface>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              getVariable(variableId: string): Promise<VariableSkeleton>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              getVariables(): Promise<VariableSkeleton[]>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              importVariable(
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  variableId: string,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  importData: VariablesExportInterface,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              ): Promise<VariableSkeleton>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              importVariables(
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  importData: VariablesExportInterface,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              ): Promise<VariableSkeleton[]>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              putVariable(
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  variableId: string,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  valueBase64: string,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  description: string,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  expressionType?: VariableExpressionType,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              ): Promise<VariableSkeleton>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              readVariable(
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  variableId: string,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  noDecode?: boolean,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              ): Promise<VariableSkeleton>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              readVariables(noDecode?: boolean): Promise<VariableSkeleton[]>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              resolveVariable(
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  input: string,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  variables: Record<string, VariableSkeleton>,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              ): Promise<string>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              setVariableDescription(
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  variableId: string,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  description: string,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              ): Promise<any>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              updateVariable(
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  variableId: string,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  value: string,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  description: string,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  expressionType?: VariableExpressionType,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  noEncode?: boolean,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              ): Promise<VariableSkeleton>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              updateVariableDescription(
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  variableId: string,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  description: string,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              ): Promise<VariableSkeleton>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          }
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Index

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Methods

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • OptionalexpressionType: VariableExpressionType

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          type of the value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • OptionalnoEncode: boolean

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          do not encode if passing a pre-encoded (base64) value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • Returns Promise<VariableSkeleton>

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          a promise that resolves to a variable object

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • Export variable. The response can be saved to file as is.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • variableId: string

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              variable id/name

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • OptionalnoDecode: boolean

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Do not decode value (default: false)

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Returns Promise<VariablesExportInterface>

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Promise resolving to a VariablesExportInterface object.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • Read variable by id/name

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • variableId: string

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              variable id/name

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • OptionalnoDecode: boolean

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Do not decode value (default: false)

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Returns Promise<VariableSkeleton>

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            a promise that resolves to a variable object

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • Attempt to resolve a string to an ESV variable in AIC deployments.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • input: string

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Input string to be evaluated as a possible ESV.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • variables: Record<string, VariableSkeleton>

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Provide an empty or prepopulated map of ESV variables. The function adds any resolved variables to the map that don't exist.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Returns Promise<string>

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Returns the resolved value of the ESV or the original input string

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • Update or create variable

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • variableId: string

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              variable id/name

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • value: string

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              variable value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • description: string

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              variable description

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • OptionalexpressionType: VariableExpressionType

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              type of the value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • OptionalnoEncode: boolean

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              do not encode if passing a pre-encoded (base64) value

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Returns Promise<VariableSkeleton>

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            a promise that resolves to a variable object

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • Update variable description

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • variableId: string

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              variable id/name

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • description: string

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              variable description

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Returns Promise<VariableSkeleton>

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            a promise that resolves to a status object

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Deprecated

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Deprecated

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          diff --git a/docs/types/Reference.VariableExpressionType.html b/docs/types/Reference.VariableExpressionType.html index b4b53f2ba..0a4836ce4 100644 --- a/docs/types/Reference.VariableExpressionType.html +++ b/docs/types/Reference.VariableExpressionType.html @@ -1,3 +1,3 @@ -VariableExpressionType | Frodo Library - v4.0.0-10
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Frodo Library - v4.0.0-10
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Type Alias VariableExpressionType

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            VariableExpressionType:
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                | "array"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                | "base64encodedinlined"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                | "bool"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                | "int"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                | "keyvaluelist"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                | "list"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                | "number"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                | "object"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                | "string"

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Variable types

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            +VariableExpressionType | Frodo Library - v4.0.0-11
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Frodo Library - v4.0.0-11
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Type Alias VariableExpressionType

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              VariableExpressionType:
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  | "array"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  | "base64encodedinlined"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  | "bool"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  | "int"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  | "keyvaluelist"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  | "list"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  | "number"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  | "object"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  | "string"

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Variable types

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              diff --git a/docs/types/Reference.VariableSkeleton.html b/docs/types/Reference.VariableSkeleton.html index 420860774..6ceefe042 100644 --- a/docs/types/Reference.VariableSkeleton.html +++ b/docs/types/Reference.VariableSkeleton.html @@ -1,2 +1,2 @@ -VariableSkeleton | Frodo Library - v4.0.0-10
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Frodo Library - v4.0.0-10
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Type Alias VariableSkeleton

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                VariableSkeleton: IdObjectSkeletonInterface & {
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    description?: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    expressionType?: VariableExpressionType;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    lastChangeDate?: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    lastChangedBy?: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    loaded?: boolean;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    value?: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    valueBase64?: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                }

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Variable object skeleton

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                +VariableSkeleton | Frodo Library - v4.0.0-11
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Frodo Library - v4.0.0-11
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Type Alias VariableSkeleton

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  VariableSkeleton: IdObjectSkeletonInterface & {
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      description?: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      expressionType?: VariableExpressionType;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      lastChangeDate?: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      lastChangedBy?: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      loaded?: boolean;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      value?: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      valueBase64?: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  }

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Variable object skeleton

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  diff --git a/docs/types/Reference.Version.html b/docs/types/Reference.Version.html index ffc664579..c8e34f964 100644 --- a/docs/types/Reference.Version.html +++ b/docs/types/Reference.Version.html @@ -1,3 +1,3 @@ -Version | Frodo Library - v4.0.0-10
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Frodo Library - v4.0.0-10
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Type Alias Version

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    type Version = {
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        getAllVersions(
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            endpoints: { base: string; path: string }[],
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        ): Promise<PromiseSettledResult<any>[]>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        getVersion(): string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    }
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Index

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Methods

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    getAllVersions +Version | Frodo Library - v4.0.0-11
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Frodo Library - v4.0.0-11
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Type Alias Version

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      type Version = {
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          getAllVersions(
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              endpoints: { base: string; path: string }[],
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          ): Promise<PromiseSettledResult<any>[]>;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          getVersion(): string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      }
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Index

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Methods

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • endpoints: { base: string; path: string }[]

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Returns Promise<PromiseSettledResult<any>[]>

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Methods

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • endpoints: { base: string; path: string }[]

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Returns Promise<PromiseSettledResult<any>[]>

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      diff --git a/docs/types/Reference.VersionOfSecretSkeleton.html b/docs/types/Reference.VersionOfSecretSkeleton.html index 2cf4e8bf5..c2cb2891e 100644 --- a/docs/types/Reference.VersionOfSecretSkeleton.html +++ b/docs/types/Reference.VersionOfSecretSkeleton.html @@ -1,7 +1,7 @@ -VersionOfSecretSkeleton | Frodo Library - v4.0.0-10
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Frodo Library - v4.0.0-10
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Type Alias VersionOfSecretSkeleton

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        VersionOfSecretSkeleton: IdObjectSkeletonInterface & {
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            createDate?: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            loaded?: boolean;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            status?: VersionOfSecretStatus;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            valueBase64?: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            version?: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        }

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Secret version skeleton

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        +VersionOfSecretSkeleton | Frodo Library - v4.0.0-11
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Frodo Library - v4.0.0-11
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Type Alias VersionOfSecretSkeleton

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          VersionOfSecretSkeleton: IdObjectSkeletonInterface & {
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              createDate?: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              loaded?: boolean;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              status?: VersionOfSecretStatus;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              valueBase64?: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              version?: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          }

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Secret version skeleton

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Type Declaration

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • OptionalcreateDate?: string

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Date string. Returned when reading a version of a secret

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • Optionalloaded?: boolean

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            True if loaded, false otherwise. Returned when reading a version of a secret

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • Optionalstatus?: VersionOfSecretStatus

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Status string. Returned when reading a version of a secret

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • OptionalvalueBase64?: string

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Base64-encoded value. Only used when creating a new version of a secret

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • Optionalversion?: string

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Version string. Returned when reading a version of a secret

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          diff --git a/docs/types/Reference.VersionOfSecretStatus.html b/docs/types/Reference.VersionOfSecretStatus.html index aa3561c80..b681d6a34 100644 --- a/docs/types/Reference.VersionOfSecretStatus.html +++ b/docs/types/Reference.VersionOfSecretStatus.html @@ -1 +1 @@ -VersionOfSecretStatus | Frodo Library - v4.0.0-10
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Frodo Library - v4.0.0-10
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Type Alias VersionOfSecretStatus

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            VersionOfSecretStatus: "DISABLED" | "ENABLED" | "DESTROYED"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            +VersionOfSecretStatus | Frodo Library - v4.0.0-11
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Frodo Library - v4.0.0-11
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Type Alias VersionOfSecretStatus

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              VersionOfSecretStatus: "DISABLED" | "ENABLED" | "DESTROYED"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              diff --git a/docs/types/Reference.WebAgentType.html b/docs/types/Reference.WebAgentType.html index 97c6d0955..3cfdea1dd 100644 --- a/docs/types/Reference.WebAgentType.html +++ b/docs/types/Reference.WebAgentType.html @@ -1 +1 @@ -WebAgentType | Frodo Library - v4.0.0-10
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Frodo Library - v4.0.0-10
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Type Alias WebAgentType

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                WebAgentType: "WebAgent"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                +WebAgentType | Frodo Library - v4.0.0-11
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Frodo Library - v4.0.0-11
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Type Alias WebAgentType

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  WebAgentType: "WebAgent"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  diff --git a/docs/types/Reference.Writable.html b/docs/types/Reference.Writable.html index a0b3c51e1..3a8ee4867 100644 --- a/docs/types/Reference.Writable.html +++ b/docs/types/Reference.Writable.html @@ -1,3 +1,3 @@ -Writable | Frodo Library - v4.0.0-10
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Frodo Library - v4.0.0-10
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Type Alias Writable<Type>

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    type Writable<Type> = {
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        inherited: boolean;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        value?: Type;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    }

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Type Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • Type
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Index

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Properties

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    inherited +Writable | Frodo Library - v4.0.0-11
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Frodo Library - v4.0.0-11
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Type Alias Writable<Type>

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      type Writable<Type> = {
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          inherited: boolean;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          value?: Type;
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      }

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Type Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • Type
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Index

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Properties

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Properties

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      inherited: boolean
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      value?: Type
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Properties

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      inherited: boolean
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      value?: Type
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      diff --git a/docs/types/Reference.tokenType.html b/docs/types/Reference.tokenType.html index 1a0282906..7b563c54f 100644 --- a/docs/types/Reference.tokenType.html +++ b/docs/types/Reference.tokenType.html @@ -1 +1 @@ -tokenType | Frodo Library - v4.0.0-10
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Frodo Library - v4.0.0-10
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Type Alias tokenType

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        tokenType: "userSession" | "userBearer" | "saBearer"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        +tokenType | Frodo Library - v4.0.0-11
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Frodo Library - v4.0.0-11
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Type Alias tokenType

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          tokenType: "userSession" | "userBearer" | "saBearer"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          diff --git a/docs/variables/frodo.html b/docs/variables/frodo.html index 7c0e6b240..10d4079e9 100644 --- a/docs/variables/frodo.html +++ b/docs/variables/frodo.html @@ -1,4 +1,4 @@ -frodo | Frodo Library - v4.0.0-10
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Frodo Library - v4.0.0-10
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Variable frodoConst

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            frodo: Frodo = ...

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Default frodo instance

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            +frodo | Frodo Library - v4.0.0-11
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Frodo Library - v4.0.0-11
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Variable frodoConst

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              frodo: Frodo = ...

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Default frodo instance

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              If your application requires a single connection to a ForgeRock Identity Platform instance at a time, then this default instance is all you need:

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              In order to use the default frodo instance, you must populate its state with the @@ -25,4 +25,4 @@

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              // use factory method to create a new Frodo instance ready to login with Amster account
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              const instance4 = frodo.createInstanceWithAmsterAccount(
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              'https://instance4/am',
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              '-----BEGIN PRIVATE KEY-----\nMIIJQgIBADANBgkqhkiG9w0BAQEFAASCCSwwggkoAgEAAoICAQCVPUZaHCRHu9i3\n...',
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              'amsterService'
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              );

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              // now the instance can login
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              instance4.login.getTokens();

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              // and perform AM operations
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              instance4.authn.journey.exportJourney('Login');
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              diff --git a/docs/variables/state.html b/docs/variables/state.html index be77a785f..633a86e95 100644 --- a/docs/variables/state.html +++ b/docs/variables/state.html @@ -1,4 +1,4 @@ -state | Frodo Library - v4.0.0-10
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Frodo Library - v4.0.0-10
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Variable stateConst

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                state: State = frodo.state

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Default state instance

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                +state | Frodo Library - v4.0.0-11
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Frodo Library - v4.0.0-11
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Variable stateConst

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  state: State = frodo.state

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Default state instance

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Frodo maintains a state for each instance. The state is where Frodo gets configuration information from like host to connecto to, username and password to use, whether to allow insecure connections or not, etc. As the library operates, it updates its state.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  @@ -8,4 +8,4 @@
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  // configure the state before invoking any library functions that require credentials
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  state.setHost('https://instance0/am');
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  state.setUsername('admin');
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  state.setPassword('p@ssw0rd!');

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  // now the library can login
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  frodo.login.getTokens();

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  // and perform operations
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  frodo.authn.journey.exportJourney('Login');
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  diff --git a/package-lock.json b/package-lock.json index 7f4b92260..7a75feb5f 100644 --- a/package-lock.json +++ b/package-lock.json @@ -1,12 +1,12 @@ { "name": "@rockcarver/frodo-lib", - "version": "4.0.0-10", + "version": "4.0.0-11", "lockfileVersion": 3, "requires": true, "packages": { "": { "name": "@rockcarver/frodo-lib", - "version": "4.0.0-10", + "version": "4.0.0-11", "license": "MIT", "devDependencies": { "@ianvs/prettier-plugin-sort-imports": "^4.7.0", diff --git a/package.json b/package.json index a9b132183..b8d7e1136 100644 --- a/package.json +++ b/package.json @@ -1,6 +1,6 @@ { "name": "@rockcarver/frodo-lib", - "version": "4.0.0-10", + "version": "4.0.0-11", "type": "commonjs", "main": "./dist/index.js", "module": "./dist/index.mjs", From c7042b38b1fbb7895f93fd0e3180adedebe13669 Mon Sep 17 00:00:00 2001 From: Devin Holderness Date: Wed, 7 Jan 2026 11:25:01 -0700 Subject: [PATCH 3/3] updated colors to use tinyrainbow --- package-lock.json | 120 +++++++++++++++++++------------------ package.json | 2 +- src/ops/AuthenticateOps.ts | 7 ++- src/shared/State.ts | 9 +-- 4 files changed, 73 insertions(+), 65 deletions(-) diff --git a/package-lock.json b/package-lock.json index 7a75feb5f..d38c00a33 100644 --- a/package-lock.json +++ b/package-lock.json @@ -29,7 +29,6 @@ "axios": "^1.13.4", "axios-mock-adapter": "^2.1.0", "axios-retry": "^4.4.0", - "colors": "^1.4.0", "copyfiles": "^2.4.1", "del": "^8.0.0", "eslint": "^9.39.2", @@ -57,6 +56,7 @@ "setup-polly-jest": "^0.11.0", "slugify": "^1.6.5", "sshpk": "^1.18.0", + "tinyrainbow": "^3.0.3", "ts-jest": "^29.1.2", "tsup": "^8.0.2", "typedoc": "^0.28.16", @@ -4157,6 +4157,27 @@ "ms": "2.0.0" } }, + "node_modules/body-parser/node_modules/http-errors": { + "version": "2.0.1", + "resolved": "https://registry.npmjs.org/http-errors/-/http-errors-2.0.1.tgz", + "integrity": "sha512-4FbRdAX+bSdmo4AUFuS0WNiPz8NgFt+r8ThgNWmlrjQjt1Q7ZR9+zTlce2859x4KSXrwIsaeTqDoKQmtP8pLmQ==", + "dev": true, + "license": "MIT", + "dependencies": { + "depd": "~2.0.0", + "inherits": "~2.0.4", + "setprototypeof": "~1.2.0", + "statuses": "~2.0.2", + "toidentifier": "~1.0.1" + }, + "engines": { + "node": ">= 0.8" + }, + "funding": { + "type": "opencollective", + "url": "https://opencollective.com/express" + } + }, "node_modules/body-parser/node_modules/ms": { "version": "2.0.0", "resolved": "https://registry.npmjs.org/ms/-/ms-2.0.0.tgz", @@ -4564,62 +4585,6 @@ "dev": true, "license": "MIT" }, - "node_modules/color-string": { - "version": "2.1.4", - "resolved": "https://registry.npmjs.org/color-string/-/color-string-2.1.4.tgz", - "integrity": "sha512-Bb6Cq8oq0IjDOe8wJmi4JeNn763Xs9cfrBcaylK1tPypWzyoy2G3l90v9k64kjphl/ZJjPIShFztenRomi8WTg==", - "dev": true, - "license": "MIT", - "dependencies": { - "color-name": "^2.0.0" - }, - "engines": { - "node": ">=18" - } - }, - "node_modules/color-string/node_modules/color-name": { - "version": "2.1.0", - "resolved": "https://registry.npmjs.org/color-name/-/color-name-2.1.0.tgz", - "integrity": "sha512-1bPaDNFm0axzE4MEAzKPuqKWeRaT43U/hyxKPBdqTfmPF+d6n7FSoTFxLVULUJOmiLp01KjhIPPH+HrXZJN4Rg==", - "dev": true, - "license": "MIT", - "engines": { - "node": ">=12.20" - } - }, - "node_modules/color/node_modules/color-convert": { - "version": "3.1.3", - "resolved": "https://registry.npmjs.org/color-convert/-/color-convert-3.1.3.tgz", - "integrity": "sha512-fasDH2ont2GqF5HpyO4w0+BcewlhHEZOFn9c1ckZdHpJ56Qb7MHhH/IcJZbBGgvdtwdwNbLvxiBEdg336iA9Sg==", - "dev": true, - "license": "MIT", - "dependencies": { - "color-name": "^2.0.0" - }, - "engines": { - "node": ">=14.6" - } - }, - "node_modules/color/node_modules/color-name": { - "version": "2.1.0", - "resolved": "https://registry.npmjs.org/color-name/-/color-name-2.1.0.tgz", - "integrity": "sha512-1bPaDNFm0axzE4MEAzKPuqKWeRaT43U/hyxKPBdqTfmPF+d6n7FSoTFxLVULUJOmiLp01KjhIPPH+HrXZJN4Rg==", - "dev": true, - "license": "MIT", - "engines": { - "node": ">=12.20" - } - }, - "node_modules/colors": { - "version": "1.4.0", - "resolved": "https://registry.npmjs.org/colors/-/colors-1.4.0.tgz", - "integrity": "sha512-a+UqTh4kgZg/SlGvfbzDHpgRu7AAQOmmqRHJnxhRZICKFUT91brVhNNt58CMWU9PsBbv3PDCZUHbVxuDiH2mtA==", - "dev": true, - "license": "MIT", - "engines": { - "node": ">=0.1.90" - } - }, "node_modules/combined-stream": { "version": "1.0.8", "resolved": "https://registry.npmjs.org/combined-stream/-/combined-stream-1.0.8.tgz", @@ -10106,6 +10071,37 @@ "node": ">= 0.8" } }, + "node_modules/raw-body/node_modules/http-errors": { + "version": "2.0.1", + "resolved": "https://registry.npmjs.org/http-errors/-/http-errors-2.0.1.tgz", + "integrity": "sha512-4FbRdAX+bSdmo4AUFuS0WNiPz8NgFt+r8ThgNWmlrjQjt1Q7ZR9+zTlce2859x4KSXrwIsaeTqDoKQmtP8pLmQ==", + "dev": true, + "license": "MIT", + "dependencies": { + "depd": "~2.0.0", + "inherits": "~2.0.4", + "setprototypeof": "~1.2.0", + "statuses": "~2.0.2", + "toidentifier": "~1.0.1" + }, + "engines": { + "node": ">= 0.8" + }, + "funding": { + "type": "opencollective", + "url": "https://opencollective.com/express" + } + }, + "node_modules/raw-body/node_modules/statuses": { + "version": "2.0.2", + "resolved": "https://registry.npmjs.org/statuses/-/statuses-2.0.2.tgz", + "integrity": "sha512-DvEy55V3DB7uknRo+4iOGT5fP1slR8wQohVdknigZPMpMstaKJQWhwiYBACJE3Ul2pTnATihhBYnRhZQHGBiRw==", + "dev": true, + "license": "MIT", + "engines": { + "node": ">= 0.8" + } + }, "node_modules/react-is": { "version": "18.3.1", "resolved": "https://registry.npmjs.org/react-is/-/react-is-18.3.1.tgz", @@ -11399,6 +11395,16 @@ "url": "https://github.com/sponsors/jonschlinkert" } }, + "node_modules/tinyrainbow": { + "version": "3.0.3", + "resolved": "https://registry.npmjs.org/tinyrainbow/-/tinyrainbow-3.0.3.tgz", + "integrity": "sha512-PSkbLUoxOFRzJYjjxHJt9xro7D+iilgMX/C9lawzVuYiIdcihh9DXmVibBe8lmcFrRi/VzlPjBxbN7rH24q8/Q==", + "dev": true, + "license": "MIT", + "engines": { + "node": ">=14.0.0" + } + }, "node_modules/tmpl": { "version": "1.0.5", "resolved": "https://registry.npmjs.org/tmpl/-/tmpl-1.0.5.tgz", diff --git a/package.json b/package.json index b8d7e1136..b50922135 100644 --- a/package.json +++ b/package.json @@ -103,7 +103,6 @@ "axios": "^1.13.4", "axios-mock-adapter": "^2.1.0", "axios-retry": "^4.4.0", - "colors": "^1.4.0", "copyfiles": "^2.4.1", "del": "^8.0.0", "eslint": "^9.39.2", @@ -131,6 +130,7 @@ "setup-polly-jest": "^0.11.0", "slugify": "^1.6.5", "sshpk": "^1.18.0", + "tinyrainbow": "^3.0.3", "ts-jest": "^29.1.2", "tsup": "^8.0.2", "typedoc": "^0.28.16", diff --git a/src/ops/AuthenticateOps.ts b/src/ops/AuthenticateOps.ts index 2a3565c30..3a69faecf 100644 --- a/src/ops/AuthenticateOps.ts +++ b/src/ops/AuthenticateOps.ts @@ -4,6 +4,7 @@ import { URL } from 'url'; import { AxiosError, AxiosRequestConfig, AxiosResponse } from 'axios'; import jose from 'node-jose'; import sshpk from 'sshpk'; +import c from 'tinyrainbow'; import { v4 } from 'uuid'; import { @@ -383,7 +384,7 @@ async function determineDeploymentType(state: State): Promise { e.response.headers?.location?.indexOf('code=') > -1 ) { verboseMessage({ - message: `ForgeRock Identity Cloud`['brightCyan'] + ` detected.`, + message: c.cyan(`ForgeRock Identity Cloud`) + ` detected.`, state, }); deploymentType = Constants.CLOUD_DEPLOYMENT_TYPE_KEY; @@ -404,13 +405,13 @@ async function determineDeploymentType(state: State): Promise { // maybe we don't want to run through the auto-detect code if we get a custom admin client id? adminClientId = state.getAdminClientId() || forgeopsClientId; verboseMessage({ - message: `ForgeOps deployment`['brightCyan'] + ` detected.`, + message: c.cyan(`ForgeOps deployment`) + ` detected.`, state, }); deploymentType = Constants.FORGEOPS_DEPLOYMENT_TYPE_KEY; } else { verboseMessage({ - message: `Classic deployment`['brightCyan'] + ` detected.`, + message: c.cyan(`Classic deployment`) + ` detected.`, state, }); } diff --git a/src/shared/State.ts b/src/shared/State.ts index 9287e3d3c..59db0559f 100644 --- a/src/shared/State.ts +++ b/src/shared/State.ts @@ -4,6 +4,7 @@ import { IAxiosRetryConfig, isNetworkOrIdempotentRequestError, } from 'axios-retry'; +import c from 'tinyrainbow'; import winston from 'winston'; import { RetryStrategy } from '../api/BaseApi'; @@ -686,11 +687,11 @@ const globalState: StateInterface = { } }, errorHandler: (error: Error, message?: string) => { - if (message) process.stderr.write('' + message['brightRed']); + if (message) process.stderr.write('' + c.red(message)); switch (error.name) { case 'FrodoError': process.stderr.write( - '' + (error as FrodoError).getCombinedMessage()['brightRed'] + '' + c.red((error as FrodoError).getCombinedMessage()) ); break; @@ -712,12 +713,12 @@ const globalState: StateInterface = { errorMessage += status ? `\n Status: ${status}` : ''; errorMessage += message ? `\n Message: ${message}` : ''; errorMessage += detail ? `\n Detail: ${detail}` : ''; - process.stderr.write(errorMessage['brightRed']); + process.stderr.write(c.red(errorMessage)); break; } default: - process.stderr.write(error.message['brightRed']); + process.stderr.write(c.red(error.message)); break; } },