Password reset events
- Thomas Oddsund (Deactivated)
Table of contents
1. About the events
These events are sent when a user has submitted their new password.
Events will be delivered in two rounds – one right before the reissue command is sent to FOI, and one right after indicating the status. These are sent asynchronously and without a guarantee for order, meaning that the command might have been executed before you receive the initial event, or that the completed event is received before the init event.
2. Types
There are two types of message, denoted by their type in the CloudEvent wrapper;
no.bankid.bass.audit.reissue.init.v1
Used for events sent right before the reissue command is sent.
This signals the intent that the user will now perform a password reset, and the user can no longer abort.no.bankid.bass.audit.reissue.completed.v1
Used for events sent right after the reissue command is sent.
This signals that the command has been sent, and will specify if the command was successful or failed.
Below, you will find the JSON Schema files defining the messages and their content.
3. Definitions
The common types are listed in section 3.4
3.1 Initiated password reset
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"$id": "InitiatedResetPasswordEvent.json",
"type": "object",
"properties": {
"sessionId": {
"type": "string",
"description": "SessionID internal to Bass"
},
"authentication": {
"$ref": "AuthMethod.json",
"description": "Authentication method used to initiate the password reset"
},
"orderID": {
"type": "string",
"description": "OrderID of the BankID certificate the password is changed on"
},
"correlationId": {
"type": "string",
"description": "CorrelationID to track across other event providers when relevant"
},
"nnin": {
"type": "string",
"description": "NNIN of the user for the BankID Certificate."
},
"action": {
"$ref": "Action.json",
"default": "REISSUE",
"description": "Action performed by the user"
},
"status": {
"$ref": "Status.json",
"default": "BEGIN",
"description": "Status of the action"
}
},
"required": [
"sessionId",
"authentication",
"orderID",
"correlationId",
"nnin",
"action",
"status"
]
}3.2 Successful password reset
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"$id": "CompletedPasswordResetEvent.json",
"type": "object",
"properties": {
"sessionId": {
"type": "string",
"description": "SessionID internal to Bass. Treat it as an opaque string."
},
"authentication": {
"$ref": "AuthMethod.json",
"description": "Authentication method used to initiate the password reset."
},
"orderID": {
"type": "string",
"description": "OrderID of the BankID certificate the password is changed on."
},
"correlationId": {
"type": "string",
"description": "CorrelationID to track across other event providers when relevant. Treat it as an opaque string."
},
"nnin": {
"type": "string",
"description": "NNIN of the user for the BankID Certificate."
},
"action": {
"$ref": "Action.json",
"default": "REISSUE",
"description": "Action performed by the user."
},
"status": {
"$ref": "Status.json",
"default": "SUCCESS",
"description": "Status of the action."
},
"time": {
"type": "string",
"format": "date-time",
"description": "Time of the call to ODS.\n\nExample: 2022-10-26T14:15:51.978Z"
}
},
"required": [
"sessionId",
"authentication",
"orderID",
"correlationId",
"action",
"nnin",
"status",
"time"
]
}3.3 Failed password reset
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"$id": "FailedPasswordResetEvent.json",
"type": "object",
"properties": {
"sessionId": {
"type": "string",
"description": "SessionID internal to Bass. Treat it as an opaque string."
},
"authentication": {
"$ref": "AuthMethod.json",
"description": "Authentication method used to initiate the password reset."
},
"orderID": {
"type": "string",
"description": "OrderID of the BankID certificate the password is changed on."
},
"correlationId": {
"type": "string",
"description": "CorrelationID to track across other event providers when relevant. Treat it as an opaque string."
},
"nnin": {
"type": "string",
"description": "NNIN of the user for the BankID Certificate."
},
"action": {
"$ref": "Action.json",
"default": "REISSUE",
"description": "Action performed by the user."
},
"status": {
"$ref": "Status.json",
"default": "FAILURE",
"description": "Status of the action."
},
"time": {
"type": "string",
"format": "date-time",
"description": "Time of the call to ODS.\n\nExample: 2022-10-26T14:15:51.978Z"
},
"additionalInfo": {
"type": "string",
"description": "Descriptive error message, or the raw error message from the RA system."
}
},
"required": [
"sessionId",
"authentication",
"orderID",
"correlationId",
"nnin",
"action",
"status",
"time",
"additionalInfo"
]
}3.4 Common types
3.4.1 Action
3.4.2 AuthMethod
3.4.3 Status