Type alias FRUtils

Type declaration

• applyNameCollisionPolicy:function

  • applyNameCollisionPolicy(name: string): string

  • Parameters

    • name: string

    Returns string

• getCurrentRealmManagedUser:function

  • getCurrentRealmManagedUser(): string

  • Returns string

• getCurrentRealmName:function

  • getCurrentRealmName(): string

  • Returns string

• getCurrentRealmPath:function

  • getCurrentRealmPath(): string

  • Returns string

• 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
    Copy

• 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

  • getRealmName(realm: string): string

  • Parameters

    • realm: string

    Returns string

• getRealmPath:function

  • getRealmPath(realm: string): string

  • Parameters

    • realm: string

    Returns string

• getRealmUsingExportFormat:function

  • 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

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