{
  "opencollection": "1.0.0",
  "info": {
    "name": "Auth0 Authentication actions prompts API",
    "version": "1.0.0"
  },
  "items": [
    {
      "info": {
        "name": "prompts",
        "type": "folder"
      },
      "items": [
        {
          "info": {
            "name": "Get Prompt Settings",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "{auth0_domain}/prompts"
          },
          "docs": "Retrieve details of the Universal Login configuration of your tenant. This includes the <a href=\"https://auth0.com/docs/authenticate/login/auth0-universal-login/identifier-first\">Identifier First Authentication</a> and <a href=\"https://auth0.com/docs/secure/multi-factor-authentication/fido-authentication-with-webauthn/configure-webauthn-device-biometrics-for-mfa\">WebAuthn with Device Biometrics for MFA</a> features."
        },
        {
          "info": {
            "name": "Update Prompt Settings",
            "type": "http"
          },
          "http": {
            "method": "PATCH",
            "url": "{auth0_domain}/prompts",
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Update the Universal Login configuration of your tenant. This includes the <a href=\"https://auth0.com/docs/authenticate/login/auth0-universal-login/identifier-first\">Identifier First Authentication</a> and <a href=\"https://auth0.com/docs/secure/multi-factor-authentication/fido-authentication-with-webauthn/configure-webauthn-device-biometrics-for-mfa\">WebAuthn with Device Biometrics for MFA</a> features."
        },
        {
          "info": {
            "name": "Get Render Setting Configurations for All Screens",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "{auth0_domain}/prompts/rendering",
            "params": [
              {
                "name": "fields",
                "value": "",
                "type": "query",
                "description": "Comma-separated list of fields to include or exclude (based on value provided for include_fields) in the result. Leave empty to retrieve all fields."
              },
              {
                "name": "include_fields",
                "value": "",
                "type": "query",
                "description": "Whether specified fields are to be included (default: true) or excluded (false)."
              },
              {
                "name": "page",
                "value": "",
                "type": "query",
                "description": "Page index of the results to return. First page is 0."
              },
              {
                "name": "per_page",
                "value": "",
                "type": "query",
                "description": "Number of results per page. Maximum value is 100, default value is 50."
              },
              {
                "name": "include_totals",
                "value": "",
                "type": "query",
                "description": "Return results inside an object that contains the total configuration count (true) or as a direct array of results (false, default)."
              },
              {
                "name": "prompt",
                "value": "",
                "type": "query",
                "description": "Name of the prompt to filter by"
              },
              {
                "name": "screen",
                "value": "",
                "type": "query",
                "description": "Name of the screen to filter by"
              },
              {
                "name": "rendering_mode",
                "value": "",
                "type": "query",
                "description": "Rendering mode to filter by"
              }
            ]
          },
          "docs": "Get render setting configurations for all screens."
        },
        {
          "info": {
            "name": "Update Render Settings for Multiple Screens",
            "type": "http"
          },
          "http": {
            "method": "PATCH",
            "url": "{auth0_domain}/prompts/rendering",
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Learn more about <a href='https://auth0.com/docs/customize/login-pages/advanced-customizations/getting-started/configure-acul-screens'>configuring render settings</a> for advanced customization.\n"
        },
        {
          "info": {
            "name": "Get Custom Text for a Prompt",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "{auth0_domain}/prompts/:prompt/custom-text/:language",
            "params": [
              {
                "name": "prompt",
                "value": "",
                "type": "path",
                "description": "Name of the prompt."
              },
              {
                "name": "language",
                "value": "",
                "type": "path",
                "description": "Language to update."
              }
            ]
          },
          "docs": "Retrieve custom text for a specific prompt and language."
        },
        {
          "info": {
            "name": "Set Custom Text for a Specific Prompt",
            "type": "http"
          },
          "http": {
            "method": "PUT",
            "url": "{auth0_domain}/prompts/:prompt/custom-text/:language",
            "params": [
              {
                "name": "prompt",
                "value": "",
                "type": "path",
                "description": "Name of the prompt."
              },
              {
                "name": "language",
                "value": "",
                "type": "path",
                "description": "Language to update."
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Set custom text for a specific prompt. Existing texts will be overwritten."
        },
        {
          "info": {
            "name": "Get Partials for a Prompt",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "{auth0_domain}/prompts/:prompt/partials",
            "params": [
              {
                "name": "prompt",
                "value": "",
                "type": "path",
                "description": "Name of the prompt."
              }
            ]
          },
          "docs": "Get template partials for a prompt"
        },
        {
          "info": {
            "name": "Set Partials for a Prompt",
            "type": "http"
          },
          "http": {
            "method": "PUT",
            "url": "{auth0_domain}/prompts/:prompt/partials",
            "params": [
              {
                "name": "prompt",
                "value": "",
                "type": "path",
                "description": "Name of the prompt."
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Set template partials for a prompt"
        },
        {
          "info": {
            "name": "Get Render Settings for a Screen",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "{auth0_domain}/prompts/:prompt/screen/:screen/rendering",
            "params": [
              {
                "name": "prompt",
                "value": "",
                "type": "path",
                "description": "Name of the prompt"
              },
              {
                "name": "screen",
                "value": "",
                "type": "path",
                "description": "Name of the screen"
              }
            ]
          },
          "docs": "Get render settings for a screen."
        },
        {
          "info": {
            "name": "Update Render Settings for a Screen",
            "type": "http"
          },
          "http": {
            "method": "PATCH",
            "url": "{auth0_domain}/prompts/:prompt/screen/:screen/rendering",
            "params": [
              {
                "name": "prompt",
                "value": "",
                "type": "path",
                "description": "Name of the prompt"
              },
              {
                "name": "screen",
                "value": "",
                "type": "path",
                "description": "Name of the screen"
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Learn more about <a href='https://auth0.com/docs/customize/login-pages/advanced-customizations/getting-started/configure-acul-screens'>configuring render settings</a> for advanced customization.\n"
        }
      ]
    }
  ],
  "bundled": true
}