API for EVerest API clients that consume authorization events from an Auth module. Provides token validation status updates and the ability to withdraw previously granted authorizations.
default local MQTT
The ID of the module as defined in the EVerest config file.
If only the evse_id is given, the granted authorization for this EVSE will be withdrawn. If only the id_token is given, the granted authorization for every EVSE where this id_token is placed will be withdrawn. If both parameters are given, the granted authorization for the given EVSE will be withdrawn, if the placed id_token matches the given id_token If no parameter is given, all granted authorizations for all EVSEs will be removed
Available only on servers:
Accepts the following message:
Withdraw granted authorization.
{
"headers": {
"replyTo": "everest_api/1/{interface_type}/{module_id}/e2m/{operation_name}/{uuid}"
},
"payload": {
"id_token": {
"value": "string",
"type": "Central"
},
"evse_id": 1
}
}
Accepts the following message:
Reply to request to withdraw authorization.
The result of a WithdrawAuthorizationRequest: Accepted in case requested authorization was removed AuthorizationNotFound in case no match for request was found EvseNotFound in case no match for evse_id was found Rejected in case module could not process the request for other reasons
Accepted
Published whenever the validation status of a token changes. The message contains the token, its validation status, and an optional array of tariff messages received at authorization time.
Available only on servers:
Accepts the following message:
Token validation status, optionally with tariff messages
The token validation status
{
"token": {
"request_id": 0,
"id_token": {
"value": "string",
"type": "Central",
"additional_info": [
{
"value": "string",
"type": "string"
}
]
},
"parent_id_token": {
"value": "string",
"type": "Central",
"additional_info": [
{
"value": "string",
"type": "string"
}
]
},
"authorization_type": "OCPP",
"connectors": [
1
],
"prevalidated": true,
"certificate": "string",
"iso15118CertificateHashData": [
{
"hashAlgorithm": "SHA256",
"issuerNameHash": "string",
"issuerKeyHash": "string",
"serialNumber": "string",
"responderURL": "string"
}
]
},
"status": "Processing",
"messages": [
{
"format": "ASCII",
"language": "string",
"content": "string"
}
]
}
Accepts the following message:
Heartbeat produced by EVerest as configured via cfg_heartbeat_interval_ms in the EVerest configuration
64bit unsigned integer. The id of every heartbeat increases by 1 and overflows when the maximum representable value is reached
Heartbeat
Accepts the following message:
Signal to EVerest that communication is good or check shall be stopped
Send 'true' at least every 'cfg_communication_check_to_s' seconds to signal module is alive. Send 'false' to stop communication check'
CommunicationCheck
Withdraw granted authorization.
Reply to request to withdraw authorization.
The result of a WithdrawAuthorizationRequest: Accepted in case requested authorization was removed AuthorizationNotFound in case no match for request was found EvseNotFound in case no match for evse_id was found Rejected in case module could not process the request for other reasons
Token validation status, optionally with tariff messages
The token validation status
Heartbeat produced by EVerest as configured via cfg_heartbeat_interval_ms in the EVerest configuration
64bit unsigned integer. The id of every heartbeat increases by 1 and overflows when the maximum representable value is reached
Signal to EVerest that communication is good or check shall be stopped
Send 'true' at least every 'cfg_communication_check_to_s' seconds to signal module is alive. Send 'false' to stop communication check'
Type of authorization of the provided token. The value of AuthorizationType can influence the authorization process
Contains the certificate information
Type for a custom id token with a free-form type
Type for an id token
IdTokenType of the provided token. Required by OCPP2.0.1 to distinguish between different types of tokens.
Type for IdToken provided by auth token providers. Contains additional information about the IdToken like the source and purpose
Ongoing token validation status
The token validation status
Request to withdraw granted authorization. If only the evse_id is given, the granted authorization for this EVSE will be withdrawn. If only the id_token is given, the granted authorization for every EVSE where this id_token is placed will be withdrawn If both parameters are given, the granted authorization for the given EVSE will be withdrawn, if the placed id_token matches the given id_token. If no parameter is given, all granted authorizations for all EVSEs will be removed
The result of a WithdrawAuthorizationRequest: Accepted in case requested authorization was removed AuthorizationNotFound in case no match for request was found EvseNotFound in case no match for evse_id was found Rejected in case module could not process the request for other reasons
Send 'true' at least every 'cfg_communication_check_to_s' seconds to signal module is alive. Send 'false' to stop communication check'
64bit unsigned integer. The id of every heartbeat increases by 1 and overflows when the maximum representable value is reached