OCPP 2.0.1 Schemas — Authorization

Functional Block: C

Types Reference: Shared types referenced below are defined in OCPP-2.0.1-DataTypes.md.
Types used only within this block are documented inline below.

#Messages

Authorize (CS → CSMS)
SendLocalList (CSMS → CS)
GetLocalListVersion (CSMS → CS)
ClearCache (CSMS → CS)

#Authorize

Direction: CS → CSMS

#AuthorizeRequest

Field	Type	Required	Constraints	Description
`idToken`	IdTokenType	Yes
`certificate`	string	No	maxLength: 5500	The X.509 certificated presented by EV and encoded in PEM format.
`iso15118CertificateHashData`	OCSPRequestDataType[]	No	minItems: 1, maxItems: 4
`customData`	CustomDataType	No

Example AuthorizeRequest

{
  "idToken": {
    "idToken": "string",
    "type": "Central"
  }
}

#AuthorizeResponse

Field	Type	Required
`idTokenInfo`	IdTokenInfoType	Yes
`certificateStatus`	AuthorizeCertificateStatusEnumType	No
`customData`	CustomDataType	No

#SendLocalList

Direction: CSMS → CS

#SendLocalListRequest

Field	Type	Required	Constraints	Description
`updateType`	UpdateEnumType	Yes
`versionNumber`	integer	Yes		In case of a full update this is the version number of the full list. In case of a differential update it is the version number of the list after the update has been applied.
`localAuthorizationList`	AuthorizationData[]	No	minItems: 1
`customData`	CustomDataType	No

Example SendLocalListRequest

{
  "updateType": "Differential",
  "versionNumber": 0
}

#SendLocalListResponse

Field	Type	Required
`status`	SendLocalListStatusEnumType	Yes
`statusInfo`	StatusInfoType	No
`customData`	CustomDataType	No

#GetLocalListVersion

Direction: CSMS → CS

#GetLocalListVersionRequest

Field	Type	Required	Constraints	Description
`customData`	CustomDataType	No

#GetLocalListVersionResponse

Field	Type	Required	Constraints	Description
`versionNumber`	integer	Yes		This contains the current version number of the local authorization list in the Charging Station.
`customData`	CustomDataType	No

#ClearCache

Direction: CSMS → CS

#ClearCacheRequest

Field	Type	Required	Constraints	Description
`customData`	CustomDataType	No

#ClearCacheResponse

Field	Type	Required
`status`	ClearCacheStatusEnumType	Yes
`statusInfo`	StatusInfoType	No
`customData`	CustomDataType	No

#Local Types

Types used only within this block's messages.

#AuthorizeCertificateStatusEnumType

Certificate status information. - if all certificates are valid: return 'Accepted'. - if one of the certificates was revoked, return 'CertificateRevoked'.

Value
`Accepted`
`SignatureError`
`CertificateExpired`
`CertificateRevoked`
`NoCertificateAvailable`
`CertChainError`
`ContractCancelled`

Used in: Authorize

#ClearCacheStatusEnumType

Accepted if the Charging Station has executed the request, otherwise rejected.

Value
`Accepted`
`Rejected`

Used in: ClearCache

#SendLocalListStatusEnumType

This indicates whether the Charging Station has successfully received and applied the update of the Local Authorization List.

Value
`Accepted`
`Failed`
`VersionMismatch`

Used in: SendLocalList

#UpdateEnumType

This contains the type of update (full or differential) of this request.

Value
`Differential`
`Full`

Used in: SendLocalList

#AuthorizationData

Contains the identifier to use for authorization.

Field	Type	Required
`idToken`	IdTokenType	Yes
`idTokenInfo`	IdTokenInfoType	No
`customData`	CustomDataType	No

Used in: SendLocalList

#OCSPRequestDataType

Field	Type	Required	Constraints	Description
`hashAlgorithm`	HashAlgorithmEnumType	Yes
`issuerKeyHash`	string	Yes	maxLength: 128	Hashed value of the issuers public key
`issuerNameHash`	string	Yes	maxLength: 128	Hashed value of the Issuer DN (Distinguished Name).
`responderURL`	string	Yes	maxLength: 512	This contains the responder URL (Case insensitive).
`serialNumber`	string	Yes	maxLength: 40	The serial number of the certificate.
`customData`	CustomDataType	No

Used in: Authorize, GetCertificateStatus