13.3.1. authorizationΒΆ

Auth token validator types

AuthorizationStatus:string
Authorization Status enum
enum:
- Accepted
- Blocked
- ConcurrentTx
- Expired
- Invalid
- NoCredit
- NotAllowedTypeEVSE
- NotAtThisLocation
- NotAtThisTime
- Unknown
CertificateStatus:string
Certificate status information
enum:
- Accepted
- SignatureError
- CertificateExpired
- CertificateRevoked
- NoCertificateAvailable
- CertChainError
- ContractCancelled
TokenValidationStatus:string
Ongoing token validation status
enum:
- Processing
- Accepted
- Rejected
- TimedOut
- Withdrawn
CustomIdToken:object
Type for a custom id token with a free-form type
properties:
value:string <required>
Arbitrary value of the IdToken
type:string <required>
Custom type of the token
IdToken:object
Type for an id token
properties:
value:string <required>
Arbitrary value of the IdToken: This has to be printable case insensitive ascii
type:string <required> (authorization-IdTokenType)
Type of the token
There is an extended definition for this object here.
additional_info:array <optional>
A list of additional custom id tokens than can be used for providing additional information for validation
array_item:object (authorization-CustomIdToken)

There is an extended definition for this object here.

ProvidedIdToken:object
Type for IdToken provided by auth token providers. Contains additional information about the IdToken like the source and purpose
properties:
request_id:integer <optional>
Id of the authorization request of this token. Could be used to put remoteStartId of OCPP2.0.1
id_token:object <required> (authorization-IdToken)
IdToken of the provided token
There is an extended definition for this object here.
parent_id_token:object <optional> (authorization-IdToken)
Parent IdToken of the provided token
There is an extended definition for this object here.
authorization_type:string <required> (authorization-AuthorizationType)
Authorization type of the token.
There is an extended definition for this object here.
connectors:array <optional>
A list of connector ids to which the authorization can be assigned
array_item:integer


prevalidated:boolean <optional>
Indicates that the id token is already validated by the provider
certificate:string <optional>
The X.509 certificated presented by EV and encoded in PEM format
iso15118CertificateHashData:array <optional>
Contains the information needed to verify the EV Contract Certificate via OCSP
array_item:object (iso15118-CertificateHashDataInfo)
An array of contract certificate infos
There is an extended definition for this object here.

TokenValidationStatusMessage:object
The token validation status
properties:
token:object <required> (authorization-ProvidedIdToken)
The id tag assigned to this transaction
There is an extended definition for this object here.
status:string <required> (authorization-TokenValidationStatus)

There is an extended definition for this object here.
messages:array <optional>

array_item:object (text_message-MessageContent)

There is an extended definition for this object here.

ValidationResult:object
Result object containing authorization status enum value and an optional parentIdTag
properties:
authorization_status:string <required> (authorization-AuthorizationStatus)

There is an extended definition for this object here.
certificate_status:string <optional> (authorization-CertificateStatus)

There is an extended definition for this object here.
reason:object <optional> (authorization-TokenValidationStatusMessage)

There is an extended definition for this object here.
expiry_time:string <optional>
Absolute UTC time point when reservation expires in RFC3339 format
format:date-time
parent_id_token:object <optional> (authorization-IdToken)
Parent Id Tag of the validated token
There is an extended definition for this object here.
evse_ids:array <optional>
Only used when the id token is valid for one or more specific evses, not for the whole charging station. Indicates for which evse ids the provided token is valid
array_item:integer


reservation_id:integer <optional>
The reservation id that is used with this validated token.
SelectionAlgorithm:string
The selection algorithm defines the logic to select one connector for an incoming token.
SelectionAlgorithm enum:
UserInput: This algorithm waits for a user to input for which connector the authorization is provided
PlugEvents: This algorithms derives the selected connector based on the order of plug in events of EVs
FindFirst: This algorithm chooses the first referenced EVSE that is available
enum:
- UserInput
- PlugEvents
- FindFirst
AuthorizationType:string
Type of authorization of the provided token. The value of AuthorizationType can influence the authorization process
enum:
- OCPP
- RFID
- Autocharge
- PlugAndCharge
- BankCard
IdTokenType:string
IdTokenType of the provided token. Required by OCPP2.0.1 to distinguish between different types of tokens.
enum:
- Central
- eMAID
- MacAddress
- ISO14443
- ISO15693
- KeyCode
- Local
- NoAuthorization
WithdrawAuthorizationRequest:object
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
properties:
evse_id:integer <required>
The evse id to withdraw authorization for.
id_token:object <required> (authorization-IdToken)
The id token to withdraw authorization for.
There is an extended definition for this object here.
WithdrawAuthorizationResult:string
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
enum:
- Accepted
- AuthorizationNotFound
- EvseNotFound
- Rejected