{"templateId":"markdown","sharedDataIds":{"sidebar":"sidebar-products/esp/sidebars.yaml"},"props":{"metadata":{"markdoc":{"tagList":["admonition"]},"type":"markdown"},"seo":{"title":"Login","description":"Integration and usage documentation.","llmstxt":{"hide":false,"sections":[{"title":"Table of contents","includeFiles":["**/*"],"excludeFiles":[]}],"excludeFiles":[]}},"dynamicMarkdocComponents":[],"compilationErrors":[],"ast":{"$$mdtype":"Tag","name":"article","attributes":{},"children":[{"$$mdtype":"Tag","name":"Heading","attributes":{"level":1,"id":"login","__idx":0},"children":["Login"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Initiates the authentication flow with SPID, CIE, or EIDAS by redirecting the user to the identity provider."]},{"$$mdtype":"Tag","name":"Admonition","attributes":{"type":"warning","name":"Deprecated endpoint"},"children":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":["The previous endpoint ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["/{environment_name}/login_file.php"]}," is deprecated. Use the endpoints below instead."]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["For the full technical reference, see the ",{"$$mdtype":"Tag","name":"a","attributes":{"href":"/products/esp/openapi/login"},"children":["OpenAPI specification"]},"."]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":4,"id":"endpoint","__idx":1},"children":["Endpoint"]},{"$$mdtype":"Tag","name":"div","attributes":{"className":"md-table-wrapper"},"children":[{"$$mdtype":"Tag","name":"table","attributes":{"className":"md"},"children":[{"$$mdtype":"Tag","name":"thead","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Method"},"children":["Method"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"URL"},"children":["URL"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Identity scheme"},"children":["Identity scheme"]}]}]},{"$$mdtype":"Tag","name":"tbody","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["GET"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["/{environment_name}/spidlogin"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["SPID / EIDAS"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["GET"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["/{environment_name}/cielogin"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["CIE"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["GET"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["/{environment_name}/cnslogin"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["CNS"]}]}]}]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":4,"id":"path-parameters","__idx":2},"children":["Path parameters"]},{"$$mdtype":"Tag","name":"div","attributes":{"className":"md-table-wrapper"},"children":[{"$$mdtype":"Tag","name":"table","attributes":{"className":"md"},"children":[{"$$mdtype":"Tag","name":"thead","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Name"},"children":["Name"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Type"},"children":["Type"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Required"},"children":["Required"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Description"},"children":["Description"]}]}]},{"$$mdtype":"Tag","name":"tbody","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["environment_name"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["string"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Yes"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["The environment path provided by Namirial during the assessment phase (e.g. ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["myintegration"]},")"]}]}]}]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":4,"id":"query-parameters","__idx":3},"children":["Query parameters"]},{"$$mdtype":"Tag","name":"div","attributes":{"className":"md-table-wrapper"},"children":[{"$$mdtype":"Tag","name":"table","attributes":{"className":"md"},"children":[{"$$mdtype":"Tag","name":"thead","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Name"},"children":["Name"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Type"},"children":["Type"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Required"},"children":["Required"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Description"},"children":["Description"]}]}]},{"$$mdtype":"Tag","name":"tbody","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["authnKey"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["string"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Yes"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["The session key obtained from the ",{"$$mdtype":"Tag","name":"a","attributes":{"href":"/products/esp/enterprise-documentation/developer-documentation/integration-guide/getkey"},"children":["Get key"]}," endpoint"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["final"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["string"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Yes"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Redirect URL called at the end of the authentication process (defined during the assessment phase)"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["reference"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["string"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["No"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Alphanumeric string (max 50 characters) used to tag the authentication request. Returned in the JWT"]}]}]}]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":4,"id":"request-example","__idx":4},"children":["Request example"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["SPID / EIDAS"]}]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"header":{"controls":{"copy":{}}},"source":"GET /{environment_name}/spidlogin\n  ?authnKey=<authnKey>\n  &final=https://your-app.example.com/callback\n"},"children":[]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["CIE"]}]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"header":{"controls":{"copy":{}}},"source":"GET /{environment_name}/cielogin\n  ?authnKey=<authnKey>\n  &final=https://your-app.example.com/callback\n"},"children":[]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["CNS"]}]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"header":{"controls":{"copy":{}}},"source":"GET /{environment_name}/cnslogin\n  ?authnKey=<authnKey>\n  &final=https://your-app.example.com/callback\n"},"children":[]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["The constructed URL must be opened in a browser. The user will be presented with the identity provider login screen."]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":4,"id":"response-examples","__idx":5},"children":["Response examples"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Redirect — Authentication successful"]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["The user is redirected to the ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["final"]}," URL with ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["sessionid"]}," and ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["sessionkey"]}," query parameters appended. Call the ",{"$$mdtype":"Tag","name":"a","attributes":{"href":"/products/esp/enterprise-documentation/developer-documentation/integration-guide/token"},"children":["Get user token"]}," endpoint to retrieve the JWT."]},{"$$mdtype":"Tag","name":"Admonition","attributes":{"type":"info"},"children":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["cnslogin"]}," returns a JWT directly as a ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["token"]}," query parameter in the redirect, instead of ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["sessionid"]}," and ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["sessionkey"]},". The ",{"$$mdtype":"Tag","name":"a","attributes":{"href":"/products/esp/enterprise-documentation/developer-documentation/integration-guide/token"},"children":["Get user token"]}," step is not required for CNS authentication."]}]}]},"headings":[{"value":"Login","id":"login","depth":1},{"value":"Endpoint","id":"endpoint","depth":4},{"value":"Path parameters","id":"path-parameters","depth":4},{"value":"Query parameters","id":"query-parameters","depth":4},{"value":"Request example","id":"request-example","depth":4},{"value":"Response examples","id":"response-examples","depth":4}],"frontmatter":{"seo":{"title":"Login"}},"lastModified":"2026-03-07T14:10:45.000Z","pagePropGetterError":{"message":"","name":""}},"slug":"/products/esp/enterprise-documentation/developer-documentation/integration-guide/login","userData":{"isAuthenticated":false,"teams":["anonymous"]},"isPublic":true}