Skip to content

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
Enum:123
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)
Response
c1BUQkJ4d3hYUWV6ZEQ4TktlSWV6ZmozVy9HNzNrQlcyRFlvMTB1TTlGKzE3dWNjdHNLV2RUN0pVNTNJQnhsVnNMMWhBS0lucGNxMC9qY0c3U3BWYlc5dktOMXFvVkhyYUIrdDFBd1VBWGM5bERzS1RnVzd1V251R3pWUEpiUmc