Skip to navigation
OCPI roamingCredentials

Unregister from a partner (admin)

Admin only. Deletes the credentials with a partner for the path version and role; it can no longer call us and we stop calling it.

Authentication

AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

Path parameters

versionenumRequired

OCPI version: 211 (2.1.1), 221 (2.2.1) or 230 (2.3.0).

Allowed values:
roleenumRequired
Our OCPI role for this partner.
Allowed values:

Request

This endpoint expects an object.
partner_idintegerRequired>=1

Roaming partner (from GET /ocpi/partners).

partner_urlstring or nullOptional>=1 character

Partner versions URL (required on POST).

partner_tokenstring or nullOptional>=1 character

Token A on POST; Token C on PUT when not already stored.

partner_token_encodingenumOptionalDefaults to auto
Allowed values:
credentialsmap from strings to any or nullOptional
credentials_urlstring or nullOptional1-255 characters

Response

Successful Response
partner_idinteger
versionenum
Allowed values:
actionenum
Allowed values:
credentials_urlstring or nullOptional
versions_urlstring or nullOptional
endpointslist of maps from strings to any or nullOptional
tokens_deactivatedinteger or nullOptional
errorstring or nullOptional

Errors

400
Bad Request Error
401
Unauthorized Error
403
Forbidden Error
404
Not Found Error
422
Unprocessable Entity Error
429
Too Many Requests Error
502
Bad Gateway Error
504
Gateway Timeout Error