EVerest API definition for auth token provider 1.0.0 documentation

EVerest API definition for auth token provider 1.0.0

Apache-2.0
application/json
ID: pionix:de:everest:auth_token_provider_API

API for EVerest API clients implementing auth token provider.

#EVerest
#Auth

Servers

mqtt://localhost:1883/everest_api/1/auth_token_provider/{module_id}mqttdefault
default local MQTT

object
module_id
required
string
The ID of the module as defined in the EVerest config file.

Operations

SEND m2e/provided_token
Direction: Module to EVerest

Operation IDsend_provided_token
Available only on servers:
- default
Accepts the following message:
Send provided tokenprovided_token
The provided token
application/json
Message IDprovided_token
object
Type for IdToken provided by auth token providers. Contains additional information about the IdToken like the source and purpose

request_id
integer
Id of the authorization request of this token. Could be used to put remoteStartId of OCPP2.0.1

required
object
Type for an id token

value
required
string
[ 0 .. 36 ] characters
Arbitrary value of the IdToken: This has to be printable case insensitive ascii

type
required
string
IdTokenType of the provided token. Required by OCPP2.0.1 to distinguish between different types of tokens.

Allowed values:
"Central"
"eMAID"
"MacAddress"
"ISO14443"
"ISO15693"
"KeyCode"
"Local"
"NoAuthorization"
array<object>
A list of additional custom id tokens than can be used for providing additional information for validation

value
required
string
[ 0 .. 36 ] characters
Arbitrary value of the IdToken

type
required
string
[ 0 .. 50 ] characters
Custom type of the token

Additional properties are allowed.
object
Type for an id token

value
required
string
[ 0 .. 36 ] characters
Arbitrary value of the IdToken: This has to be printable case insensitive ascii

type
required
string
IdTokenType of the provided token. Required by OCPP2.0.1 to distinguish between different types of tokens.

Allowed values:
"Central"
"eMAID"
"MacAddress"
"ISO14443"
"ISO15693"
"KeyCode"
"Local"
"NoAuthorization"
array<object>
A list of additional custom id tokens than can be used for providing additional information for validation

value
required
string
[ 0 .. 36 ] characters
Arbitrary value of the IdToken

type
required
string
[ 0 .. 50 ] characters
Custom type of the token

Additional properties are allowed.
authorization_type
required
string
Type of authorization of the provided token. The value of AuthorizationType can influence the authorization process

Allowed values:
"OCPP"
"RFID"
"Autocharge"
"PlugAndCharge"
"BankCard"
array<integer>
A list of connector ids to which the authorization can be assigned

Items:
integer
>= 1
prevalidated
boolean
Indicates that the id token is already validated by the provider

certificate
string
<= 5500 characters
The X.509 certificated presented by EV and encoded in PEM format

array<object>
[ 1 .. 4 ] items
Contains the information needed to verify the EV Contract Certificate via OCSP

hashAlgorithm
required
string
Used algorithms for the hashes provided

Allowed values:
"SHA256"
"SHA384"
"SHA512"
issuerNameHash
required
string
<= 128 characters
Hashed value of the Issuer Distinguished Name

issuerKeyHash
required
string
<= 128 characters
Hashed value of the issuers public key

serialNumber
required
string
<= 40 characters
The serial number of the certificate

responderURL
required
string
<= 512 characters
This contains the responder URL

Additional properties are allowed.
Examples
#1 Example
CommunicationCheck
{ "authorization_type": "OCPP", "id_token": { "type": "Central", "value": "TOKEN" } }
RECEIVE e2m/heartbeat
Operation IDreceive_heartbeat
Available only on servers:
- default
Accepts the following message:
Receive heartbeatreceive_heartbeat
Heartbeat produced by EVerest as configured via cfg_heartbeat_interval_ms in the EVerest configuration
application/json
Message IDreceive_heartbeat
Payload
integer
64bit unsigned integer. The id of every heartbeat increases by 1 and overflows when the maximum representable value is reached

Examples
#1 Example
Heartbeat
42
SEND m2e/communication_check
Operation IDsend_communication_check
Available only on servers:
- default
Accepts the following message:
Send communication checksend_communication_check
Signal to EVerest that communication is good or check shall be stopped
application/json
Message IDsend_communication_check
Payload
boolean
Send 'true' at least every 'cfg_communication_check_to_s' seconds to signal module is alive. Send 'false' to stop communication check'

Examples
#1 Example
CommunicationCheck

Messages

#1Send provided tokensend_provided_token
The provided token
- application/json
Message IDsend_provided_token
object
Type for IdToken provided by auth token providers. Contains additional information about the IdToken like the source and purpose

request_id
integer
Id of the authorization request of this token. Could be used to put remoteStartId of OCPP2.0.1

required
object
Type for an id token

value
required
string
[ 0 .. 36 ] characters
Arbitrary value of the IdToken: This has to be printable case insensitive ascii

type
required
string
IdTokenType of the provided token. Required by OCPP2.0.1 to distinguish between different types of tokens.

Allowed values:
"Central"
"eMAID"
"MacAddress"
"ISO14443"
"ISO15693"
"KeyCode"
"Local"
"NoAuthorization"
array<object>
A list of additional custom id tokens than can be used for providing additional information for validation

value
required
string
[ 0 .. 36 ] characters
Arbitrary value of the IdToken

type
required
string
[ 0 .. 50 ] characters
Custom type of the token

Additional properties are allowed.
object
Type for an id token

value
required
string
[ 0 .. 36 ] characters
Arbitrary value of the IdToken: This has to be printable case insensitive ascii

type
required
string
IdTokenType of the provided token. Required by OCPP2.0.1 to distinguish between different types of tokens.

Allowed values:
"Central"
"eMAID"
"MacAddress"
"ISO14443"
"ISO15693"
"KeyCode"
"Local"
"NoAuthorization"
array<object>
A list of additional custom id tokens than can be used for providing additional information for validation

value
required
string
[ 0 .. 36 ] characters
Arbitrary value of the IdToken

type
required
string
[ 0 .. 50 ] characters
Custom type of the token

Additional properties are allowed.
authorization_type
required
string
Type of authorization of the provided token. The value of AuthorizationType can influence the authorization process

Allowed values:
"OCPP"
"RFID"
"Autocharge"
"PlugAndCharge"
"BankCard"
array<integer>
A list of connector ids to which the authorization can be assigned

Items:
integer
>= 1
prevalidated
boolean
Indicates that the id token is already validated by the provider

certificate
string
<= 5500 characters
The X.509 certificated presented by EV and encoded in PEM format

array<object>
[ 1 .. 4 ] items
Contains the information needed to verify the EV Contract Certificate via OCSP

hashAlgorithm
required
string
Used algorithms for the hashes provided

Allowed values:
"SHA256"
"SHA384"
"SHA512"
issuerNameHash
required
string
<= 128 characters
Hashed value of the Issuer Distinguished Name

issuerKeyHash
required
string
<= 128 characters
Hashed value of the issuers public key

serialNumber
required
string
<= 40 characters
The serial number of the certificate

responderURL
required
string
<= 512 characters
This contains the responder URL

Additional properties are allowed.
#2Receive heartbeatreceive_heartbeat
Heartbeat produced by EVerest as configured via cfg_heartbeat_interval_ms in the EVerest configuration
- application/json
Message IDreceive_heartbeat
Payload
integer
64bit unsigned integer. The id of every heartbeat increases by 1 and overflows when the maximum representable value is reached
#3Send communication checksend_communication_check
Signal to EVerest that communication is good or check shall be stopped
- application/json
Message IDsend_communication_check
Payload
boolean
Send 'true' at least every 'cfg_communication_check_to_s' seconds to signal module is alive. Send 'false' to stop communication check'

Schemas

CommunicationCheck
boolean
Send 'true' at least every 'cfg_communication_check_to_s' seconds to signal module is alive. Send 'false' to stop communication check'
HeartBeatId
integer
64bit unsigned integer. The id of every heartbeat increases by 1 and overflows when the maximum representable value is reached

EVerest API definition for auth token provider 1.0.0

Servers

Operations

SEND m2e/provided_token

Examples

#1 Example

RECEIVE e2m/heartbeat

Examples

#1 Example

SEND m2e/communication_check

Examples

#1 Example

Messages

Schemas