Create SSE ticket

POST 
/v2/config/sse-ticket

Exchanges the Authorization header of the caller for a one-time ticket for one Server-Sent Events (SSE) operation. The browser EventSource API cannot set request headers, so the client puts only the ticket in the SSE URL, in the ticket query parameter. The access token or API key then does not appear in a URL or in an access log.

SSE operations that accept a ticket

Give one of these paths in path:

• /v2/config/digital-wallet/openid/notifications/sse - stream notifications - /v3/config/digital-wallet/openid/notifications/presentation-status/sse - stream verification status

Rules

• The caller must be allowed to open the SSE operation of path. A ticket never gives more access than a request to that operation with the same Authorization header.
• The ticket is valid for expiresIn seconds (30) and for one request to path only. An unknown, used or expired ticket, or a ticket for another path, gives 401 on the SSE operation.
• The SSE request with the ticket runs as the caller of this operation: the Authorization header of this request applies, not the headers of the SSE request.
• Get a new ticket for each connection, also when the client reconnects.

Request

application/json

Body

required

path stringrequired

Possible values: [/v2/config/digital-wallet/openid/notifications/sse, /v3/config/digital-wallet/openid/notifications/presentation-status/sse]

Path (with the version prefix) of the SSE operation that the ticket is for.

Responses

201

Created. The ticket is valid for one request to the SSE operation of path.

Response Headers

application/json

Schema

Schema

ticket stringrequired

One-time ticket. Put it in the ticket query parameter of the SSE operation of path.

expiresIn integerrequired

Lifetime of the ticket in seconds.

Example (from schema)

{
  "ticket": "q3Jx0b7T8c2vY1nK5mW9pL4sR6uE0aZ2hD8fG3jC1tQ",
  "expiresIn": 30
}

400

The body is not JSON, or path is not one of the SSE operations above.

Response Headers

application/json

Schema

Schema

errorCode integerrequired
errorDescription stringrequired

Example (from schema)

{
  "errorCode": 400,
  "errorDescription": "Bad input parameter"
}

Example

{
  "errorCode": 400,
  "errorDescription": "path is not an SSE route"
}

401

The Authorization header is missing or not valid.

Response Headers

application/json

Schema

Schema

errorCode integerrequired
errorDescription stringrequired

Example (from schema)

{
  "errorCode": 400,
  "errorDescription": "Bad input parameter"
}

403

The caller is not allowed to open the SSE operation of path.

Response Headers

application/json

Schema

Schema

Code integer
Message string

Example (from schema)

{
  "Code": 403,
  "Message": "Unauthorized access;User doesn't have enough permissions;"
}

Loading...