Type Alias FRUtils

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;
}

Type declaration

  • applyNameCollisionPolicy:function
  • getCurrentRealmManagedUser:function
  • getCurrentRealmName:function
  • getCurrentRealmPath:function
  • getHostBaseUrl:function
    • getHostBaseUrl(url: string): string

      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

      Deprecated

      since v2.1.2 use getHostUrl instead

      getHostUrl(url: string): string
  • getHostUrl:function
    • getHostUrl(url: string): string

      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

  • getIdmBaseUrl:function
    • getIdmBaseUrl(): string

      Get IDM base URL

      Returns string

      IDM host URL without path and query params

  • getRealmName:function
  • getRealmPath:function
  • getRealmsForExport:function
    • getRealmsForExport(): Promise<string[]>

      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[]>

  • getRealmUsingExportFormat:function
    • getRealmUsingExportFormat(realm: string): string

      Parameters

      • realm: string

      Returns string

    • getRealmUsingExportFormat(realm: string): 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

Settings

Member Visibility