ForgeRock Developer Experience

Prepare an apple-app-site-association file

You can create an apple-app-site-association file that creates a secure association between your domain and your app. This allows you to share credentials, and use universal links to open your app from your website.

To create the secure association, you upload the apple-app-site-association file to your domain, and add matching Associated Domains Entitlement keys to your app.

  1. Prepare an apple-app-site-association file. For example:

    {
  "applinks": {
    "details": [
      {
        "appIDs": [
          "XXXXXXXXXX.com.example.AppName"
        ],
        "components": [
          {
            "/": "/reset/*",
            "comment": "Success after reset password journey"
          }
        ]
      }
    ]
  },
  "webcredentials": {
    "apps": [
      "XXXXXXXXXX.com.example.AppName"
    ]
  }
}

    For more information, refer to Supporting associated domains.

  2. Host the file at your domain.

    • For ForgeRock Identity Cloud deployments, refer to Upload an apple-app-site-association file in the Identity Cloud documentation.

    • For self-managed deployments, host the file at https://<your domain>/.well-known/apple-app-site-association.

  3. Configure the associated domains entitlement key in your app.

    For more information, refer to Associated Domains Entitlement.