Frodo Library - v5.0.0-47
    Preparing search index...

    Type Alias Application

    type Application = {
        createApplication(
            applicationId: string,
            applicationData: ApplicationGlossarySkeleton,
        ): Promise<ApplicationGlossarySkeleton>;
        createApplicationExportTemplate(): ApplicationExportInterface;
        deleteApplication(
            applicationId: string,
            deep?: boolean,
        ): Promise<ApplicationGlossarySkeleton>;
        deleteApplicationByName(
            applicationName: string,
            deep?: boolean,
        ): Promise<ApplicationGlossarySkeleton>;
        deleteApplicationOwnedObjects(
            applicationData: ApplicationSkeleton,
            options?: ApplicationOwnedDeleteOptions,
        ): Promise<ApplicationOwnedObjectResult[]>;
        deleteApplicationOwnedObjectsById(
            applicationId: string,
            options?: ApplicationOwnedDeleteOptions,
        ): Promise<ApplicationOwnedObjectResult[]>;
        deleteApplicationOwnedObjectsByName(
            applicationName: string,
            options?: ApplicationOwnedDeleteOptions,
        ): Promise<ApplicationOwnedObjectResult[]>;
        deleteApplications(deep?: boolean): Promise<ApplicationGlossarySkeleton[]>;
        disableApplication(
            applicationId: string,
        ): Promise<ApplicationStatusChangeResult>;
        disableApplicationByName(
            applicationName: string,
        ): Promise<ApplicationStatusChangeResult>;
        enableApplication(
            applicationId: string,
            options?: ConnectorEnableOptions,
        ): Promise<ApplicationStatusChangeResult>;
        enableApplicationByName(
            applicationName: string,
            options?: ConnectorEnableOptions,
        ): Promise<ApplicationStatusChangeResult>;
        exportApplication(
            applicationId: string,
            options: ApplicationExportOptions,
        ): Promise<ApplicationExportInterface>;
        exportApplicationByName(
            applicationName: string,
            options: ApplicationExportOptions,
        ): Promise<ApplicationExportInterface>;
        exportApplications(
            options?: ApplicationExportOptions,
            resultCallback?: ResultCallback<ApplicationGlossarySkeleton>,
        ): Promise<ApplicationExportInterface>;
        getApplicationOwners(
            ownership: ApplicationOwnership,
            kind: ApplicationOwnedKind,
            id: string,
        ): ApplicationOwner[];
        getApplicationOwnership(
            applications: ApplicationSkeleton[],
        ): ApplicationOwnership;
        getApplicationRecordReferences(
            applicationData: ApplicationSkeleton,
        ): ApplicationReference[];
        getRealmManagedApplication(): string;
        importApplication(
            applicationId: string,
            importData: ApplicationExportInterface,
            options: ApplicationImportOptions,
        ): Promise<ApplicationGlossarySkeleton>;
        importApplicationByName(
            applicationName: string,
            importData: ApplicationExportInterface,
            options: ApplicationImportOptions,
        ): Promise<ApplicationGlossarySkeleton>;
        importApplications(
            importData: ApplicationExportInterface,
            options: ApplicationImportOptions,
            resultCallback?: ResultCallback<ApplicationGlossarySkeleton>,
        ): Promise<ApplicationGlossarySkeleton[]>;
        importFirstApplication(
            importData: ApplicationExportInterface,
            options: ApplicationImportOptions,
        ): Promise<ApplicationGlossarySkeleton[]>;
        queryApplications(
            filter: string,
            fields?: string[],
        ): Promise<ApplicationSkeleton[]>;
        readApplication(applicationId: string): Promise<ApplicationSkeleton>;
        readApplicationByName(
            applicationName: string,
        ): Promise<ApplicationSkeleton>;
        readApplicationOwnership(): Promise<ApplicationOwnership>;
        readApplicationReferences(
            applicationId: string,
        ): Promise<ApplicationReferences>;
        readApplicationReferencesByName(
            applicationName: string,
        ): Promise<ApplicationReferences>;
        readApplications(): Promise<ApplicationSkeleton[]>;
        readApplicationStatus(
            applicationId: string,
        ): Promise<ApplicationStatusResult>;
        readApplicationStatusByName(
            applicationName: string,
        ): Promise<ApplicationStatusResult>;
        readApplicationStatuses(): Promise<ApplicationStatusResult[]>;
        updateApplication(
            applicationId: string,
            applicationData: ApplicationSkeleton,
        ): Promise<ApplicationSkeleton>;
        validateApplication(
            applicationId: string,
        ): Promise<ApplicationValidationFinding[]>;
        validateApplicationByName(
            applicationName: string,
        ): Promise<ApplicationValidationFinding[]>;
        validateApplications(): Promise<ApplicationValidationFinding[]>;
    }
    Index
    • Delete the objects an application owns: the OAuth2 client, the SAML entity providers (and their membership in circles of trust), the mappings and the connector that its record names. The record itself is not deleted (delete it first, with deep off, and pass the record that comes back), and the objects an application only shares (scripts, circles of trust, glossary schemas, request forms, request types) are never touched. An object that another application still names is kept. Every object is reported to the result callback once; a failure of one object does not stop the others and is not thrown.

      Parameters

      Returns Promise<ApplicationOwnedObjectResult[]>

      a promise that resolves to what happened to each owned object

    • Delete the objects an application owns, by application id. The application is read first, so it must still exist: to delete the record first, pass the record that deleteApplication returns to deleteApplicationOwnedObjects.

      Parameters

      • applicationId: string

        application uuid

      • Optionaloptions: ApplicationOwnedDeleteOptions

        the ownership index to use (read once if not given) and the result callback

      Returns Promise<ApplicationOwnedObjectResult[]>

      a promise that resolves to what happened to each owned object

    • Delete the objects an application owns, by application name. The application is read first, so it must still exist: to delete the record first, pass the record that deleteApplicationByName returns to deleteApplicationOwnedObjects.

      Parameters

      • applicationName: string

        application name

      • Optionaloptions: ApplicationOwnedDeleteOptions

        the ownership index to use (read once if not given) and the result callback

      Returns Promise<ApplicationOwnedObjectResult[]>

      a promise that resolves to what happened to each owned object

    • Disable an application: disable its connector. An application without a connector has no status to change and is an error.

      Parameters

      • applicationId: string

        application uuid

      Returns Promise<ApplicationStatusChangeResult>

      a promise that resolves to the status of the application after the change

    • Enable an application: enable its connector and wait until the connector answers its connection test (see ConnectorOps.enableConnector). An application without a connector has no status to change and is an error.

      Parameters

      • applicationId: string

        application uuid

      • Optionaloptions: ConnectorEnableOptions

        how long to wait for the connector to answer (milliseconds)

      Returns Promise<ApplicationStatusChangeResult>

      a promise that resolves to the status of the application after the change

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

      Parameters

      • Optionaloptions: ApplicationExportOptions

        export options

      • OptionalresultCallback: ResultCallback<ApplicationGlossarySkeleton>

        Optional callback to process individual results. When given, the outcome of every application is passed to it as it happens (a failed application as an error that names it, with the reasons nested) and a failed application does not throw: the applications that could be exported are returned. The dependencies of a failed application that were read before it failed may still be in the export. Without it, the failures are collected and thrown as one error after every application was tried. Failing to read the applications always throws.

      Returns Promise<ApplicationExportInterface>

      Promise resolving to an ApplicationExportInterface object.

    • List the references that an application record holds itself: the OAuth2 client, the SAML entity providers, the connector and the mappings it names, all of them owned by the application. Nothing is read, so this works on a record that comes from a file as well as on one read from a tenant.

      Parameters

      Returns ApplicationReference[]

      the references in the record

    • Get application managed object type

      Returns string

      application managed object type in this realm

    • Import applications. The import data is usually read from an application export file. The import writes the configuration fields of the application with a PUT. A PUT that does not carry members, owners and roles leaves them as they are, so an import does not remove who has access. Every application is tried: an application that cannot be imported does not stop the others.

      Parameters

      • importData: ApplicationExportInterface

        application import data.

      • options: ApplicationImportOptions

        import options (deps: also import the dependencies of the application)

      • OptionalresultCallback: ResultCallback<ApplicationGlossarySkeleton>

        Optional callback to process individual results. When given, the outcome of every application is passed to it as it happens (a failed application as an error that names it, with the reasons nested) and a failed application does not throw: the applications that could be imported are returned. An application whose dependencies or glossary could not be imported is a failed application, although the application itself may have been written. Without it, the failures are collected and thrown as one error after every application was tried.

      Returns Promise<ApplicationGlossarySkeleton[]>

    • Import first application. The import data is usually read from an application export file. Only the first application of the import data is imported. The import writes the configuration fields of the application with a PUT. A PUT that does not carry members, owners and roles leaves them as they are, so an import does not remove who has access.

      Parameters

      Returns Promise<ApplicationGlossarySkeleton[]>

      a promise resolving to an array that holds the imported application

      If the import data holds no application, or the first application cannot be imported.

    • Read which application owns which object in the current realm: every OAuth2 client, SAML provider, connector and mapping that an application record names. Reads the applications once and nothing else, because the owned objects are named in the records. An object that two applications name lists both of them as owners; what that means is up to the caller. Objects that applications only share (scripts, circles of trust and the like) are not indexed.

      Returns Promise<ApplicationOwnership>

      a promise that resolves to the ownership index

    • Read what an application is made of: every object that its record points to, and the scripts, circles of trust and (on Identity Governance tenants) glossary schemas, request forms and request types that those objects use. Every reference says what it points to, whether the application owns it (it exists because of the application) or shares it (other applications can use it too), and where the reference comes from. References that could not be followed (the object does not exist, or could not be read) are listed as problems; they do not make the call fail.

      Parameters

      • applicationId: string

        application uuid

      Returns Promise<ApplicationReferences>

      a promise that resolves to the references of the application

    • Read what an application is made of, by application name. See readApplicationReferences.

      Parameters

      • applicationName: string

        application name

      Returns Promise<ApplicationReferences>

      a promise that resolves to the references of the application

    • Read the status of an application. Only a provisioning application, one with a connector, has a status, and it is the state of its connector: active if the connector is enabled, inactive if it is disabled. Every other application, and one whose connector configuration does not exist, has status none.

      Parameters

      • applicationId: string

        application uuid

      Returns Promise<ApplicationStatusResult>

      a promise that resolves to the status of the application

    • Read the status of every application of the realm: the applications are read once and the enabled state of all connectors in one more request. See readApplicationStatus.

      Returns Promise<ApplicationStatusResult[]>

      a promise that resolves to the status of every application

    • Validate an application: check that every object its record refers to, and every script, circle of trust and (on Identity Governance tenants) glossary schema, request form and request type that those objects use, exists. Reads only; no template is needed. One finding is returned for every reference that does not resolve or could not be checked.

      Parameters

      • applicationId: string

        application uuid

      Returns Promise<ApplicationValidationFinding[]>

      validation findings, empty if every reference resolves