Frodo Library - v4.8.5
    Preparing search index...

    Type Alias ConnectionProfile

    type ConnectionProfile = {
        addAdditionalServiceAccount(
            host: string,
            name: string,
            svcacctId: string,
            svcacctJwk: JwkRsa,
            svcacctScope?: string,
        ): Promise<void>;
        addNewServiceAccount(): Promise<IdObjectSkeletonInterface>;
        deleteConnectionProfile(host: string): void;
        deleteConnectionProfileAlias(host: string): void;
        findConnectionProfiles(
            connectionProfiles: ConnectionsFileInterface,
            host: string,
        ): SecureConnectionProfileInterface[];
        getAdditionalServiceAccount(
            host: string,
            name: string,
        ): Promise<AdditionalServiceAccountInterface>;
        getConnectionProfile(): Promise<ConnectionProfileInterface>;
        getConnectionProfileByHost(
            host: string,
        ): Promise<ConnectionProfileInterface>;
        getConnectionProfilesPath(): string;
        initConnectionProfiles(): Promise<void>;
        listAdditionalServiceAccounts(
            host: string,
        ): Pick<
            AdditionalServiceAccountInterface,
            "name"
            | "svcacctId"
            | "svcacctScope",
        >[];
        loadConnectionProfile(): Promise<boolean>;
        loadConnectionProfileByHost(host: string): Promise<boolean>;
        removeAdditionalServiceAccount(host: string, name: string): void;
        saveConnectionProfile(host: string): Promise<boolean>;
        setConnectionProfileAlias(host: string, alias: string): void;
    }
    Index

    Methods

    addAdditionalServiceAccount addNewServiceAccount deleteConnectionProfile deleteConnectionProfileAlias findConnectionProfiles getAdditionalServiceAccount getConnectionProfile getConnectionProfileByHost getConnectionProfilesPath initConnectionProfiles listAdditionalServiceAccounts loadConnectionProfile loadConnectionProfileByHost removeAdditionalServiceAccount saveConnectionProfile setConnectionProfileAlias

    Methods

    • Add a named, independently-addressable service account to a connection profile, alongside its own single primary service account.

      Parameters

      • host: string

        host tenant, host url, unique substring, or alias

      • name: string

        unique name for this additional service account, within this profile

      • svcacctId: string

        service account uuid

      • svcacctJwk: JwkRsa

        service account JWK

      • OptionalsvcacctScope: string

        (optional) granted OAuth2 scope

      Returns Promise<void>

    • Delete connection profile

      Parameters

      • host: string

        host tenant, host url, unique substring, or alias

      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

    • 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

    • Remove a named additional service account from a connection profile.

      Parameters

      • host: string

        host tenant, host url, unique substring, or alias

      • name: string

        name of the additional service account to remove

      Returns void

    • 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

      Parameters

      • host: string

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

      • alias: string

        alias to be assigned to connection profile

      Returns void

    Settings

    Member Visibility

    On This Page

    Methods