Skip to content
DEVELOPER DOCUMENTATION
/
API Overview
/
/
Get a authn key to start...

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

Get a authn key to start an authentication flow

Request

Security
ApiKeyAuth
Path
environment_namestringrequired

The environment path provided by Namirial during the assessment phase

Example: myintegration
Query
levelinteger

Authentication level. Accepted values: 1, 2, 3.

Default 1
Enum123
Example: level=2
attributesstringrequired

Attribute set to request. Accepted values: Base, Full.

Enum"Base""Full"
Example: attributes=Full
spidTypestring

SPID SAML Purpose value. Applies to SPID authentication only.

Enum"P""LP""PG""PF""PX"
Example: spidType=P
curl -i -X GET \
  'https://esp-saas.test.namirialtsp.com/api/secure/myintegration/getKey?level=2&attributes=Full&spidType=P' \
  -H 'Esp-Api-Key: YOUR_API_KEY_HERE'

Responses

The authn key

Bodytext/plain
string(GetKeyResponse)

Get a authn key to start an authentication flow
Deprecated

Request

Security
sslCertificate
Path
environment_namestringrequired

The environment path provided by Namirial during the assessment phase

Example: myintegration
Query
levelinteger

Authentication level. Accepted values: 1, 2, 3.

Default 1
Enum123
Example: level=2
attributesstringrequired

Attribute set to request. Accepted values: Base, Full.

Enum"Base""Full"
Example: attributes=Full
curl -i -X GET \
  'https://esp-saas.test.namirialtsp.com/sslprotected/myintegration/getKey.php?level=2&attributes=Full' \
  -H 'X-SSL-Client-Cert: YOUR_API_KEY_HERE'

Responses

The authn key

Bodytext/html
string(GetKeyResponse)

Get a authn key to start an authentication flow
Deprecated

Request

Security
sslCertificate
Path
environment_namestringrequired

The integration name provided to the customer

Example: myintegration
Query
levelinteger

Authentication level. Accepted values: 1, 2, 3.

Default 1
Enum123
Example: level=2
attributesstringrequired

Attribute set to request. Accepted values: Base, Full.

Enum"Base""Full"
Example: attributes=Full
spidTypestring

SPID SAML Purpose value. Applies to SPID authentication only.

Enum"P""LP""PG""PF""PX"
Example: spidType=P
curl -i -X GET \
  'https://esp-saas.test.namirialtsp.com/sslprotected/myintegration/getKey?level=2&attributes=Full&spidType=P' \
  -H 'X-SSL-Client-Cert: YOUR_API_KEY_HERE'

Responses

The authn key

Bodytext/html
string(GetKeyResponse)

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