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 getCurrentRealmManagedUser getCurrentRealmName getCurrentRealmPath getHostUrl getIdmBaseUrl getRealmName getRealmPath getRealmsForExport getRealmUsingExportFormat

    Deprecated

    getHostBaseUrl

    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. 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. 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

      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

    Settings

    Member Visibility

    On This Page

    Methods
    Deprecated