Skip to content
DEVELOPER DOCUMENTATION
/
/Get user

ESP APIs (26.0.0)

ESP APIs provide authentication flows via SPID, CIE, CNS, and EIDAS. Use these endpoints to obtain a session key, initiate a login, and retrieve a JWT containing the user's identity attributes.

Official ESP documentation
Download OpenAPI description
openapi.json
openapi.yaml
Overview
License
Apache 2.0
Languages
Servers
Development and testing environment
https://esp-saas.test.namirialtsp.com
Production environment
https://esp-saas.namirialtsp.com

Get Key

Returns a session key (authnKey) to initiate an authentication flow with SPID, CIE, or EIDAS.

Operations

Login

Initiates the authentication flow with SPID/EIDAS, CIE, or CNS.

Operations

Logout

Initiates the SPID logout flow. Not required for Level 2 authentications.

Operations

Get user

Exchanges the session id and key (returned after login) for a JWT containing the user's identity attributes.

Operations

Get a user JWT

Request

Security
ApiKeyAuth
Path
environment_namestringrequired

The environment path provided by Namirial during the assessment phase

Example: myintegration
Query
sessionidstringrequired

The user identifier returned as a query parameter in the redirect to the final URL after login.

Example: sessionid=_ecf182c0024338b109397ea3d04ab141
sessionkeystringrequired

The session key returned as a query parameter in the redirect to the final URL after login.

Example: sessionkey=_029da15302d1f7bf8a4ff9826b4489c3
curl -i -X GET \
  'https://esp-saas.test.namirialtsp.com/api/secure/myintegration/getUser?sessionid=_ecf182c0024338b109397ea3d04ab141&sessionkey=_029da15302d1f7bf8a4ff9826b4489c3' \
  -H 'Esp-Api-Key: YOUR_API_KEY_HERE'

Responses

JWT containing the user's SAML assertion attributes

Bodytext/plain
string(JWTBearerResponse)

A signed JWT containing the user's SAML assertion attributes. The claims vary by identity scheme (SPID vs CIE). See Get user token for decoded examples.

Get a user JWT
Deprecated

Request

Security
sslCertificate
Path
environment_namestringrequired

The environment path provided by Namirial during the assessment phase

Example: myintegration
Query
IDstringrequired

The ESP user identifier

Example: ID=_ecf182c0024338b109397ea3d04ab141
keystringrequired

The ESP session key

Example: key=_029da15302d1f7bf8a4ff9826b4489c3
curl -i -X GET \
  'https://esp-saas.test.namirialtsp.com/sslprotected/myintegration/getUser.php?ID=_ecf182c0024338b109397ea3d04ab141&key=_029da15302d1f7bf8a4ff9826b4489c3' \
  -H 'X-SSL-Client-Cert: YOUR_API_KEY_HERE'

Responses

The authn key

Bodytext/html
string(JWTBearerResponse)

A signed JWT containing the user's SAML assertion attributes. The claims vary by identity scheme (SPID vs CIE). See Get user token for decoded examples.

Get a user JWT
Deprecated

Request

Security
sslCertificate
Path
environment_namestringrequired

The environment path provided by Namirial during the assessment phase

Example: myintegration
Query
IDstringrequired

The ESP user identifier

Example: ID=_ecf182c0024338b109397ea3d04ab141
keystringrequired

The ESP session key

Example: key=_029da15302d1f7bf8a4ff9826b4489c3
curl -i -X GET \
  'https://esp-saas.test.namirialtsp.com/sslprotected/myintegration/getUser?ID=_ecf182c0024338b109397ea3d04ab141&key=_029da15302d1f7bf8a4ff9826b4489c3' \
  -H 'X-SSL-Client-Cert: YOUR_API_KEY_HERE'

Responses

The authn key

Bodytext/html
string(JWTBearerResponse)

A signed JWT containing the user's SAML assertion attributes. The claims vary by identity scheme (SPID vs CIE). See Get user token for decoded examples.