Authentication

CarNeo uses Bearer Authentication Tokens.
An API request have to contain the Authorization-Header in the following pattern.

Bearer [TOKEN]

User Authentication via Volkswagen CloudIDP

Hint: Volkswagen's CloudIDP is currently intended for developers who work closely with Volkswagen and is only open to that group; authentication will be extended to external developers in the future. You can skip CloudIDP registration by using Service Account Authentication, but for the best developer experience we recommend contacting the CarNEO team and setting up a CloudIDP account first.

The registration dialog opens automatically when the frontend is called. In the Swagger-UI, click the Authorize Button on the upper right side.
In the dialog window, click the Authorize Button.
You will be redirected to CloudIDP where you can authenticate yourself.
After completing the registration you will be redirected back to the Swagger UI.
Exit the dialog window with the Close Button.

Authentication via "Service Account"

It is possible to create additional accounts to access your data collection. These so-called "Service Accounts" enable software based authentication.

Please see section Service Account to set up the Service Account Authentication.

Authenticate Identity & Roles

You always authenticate your so-called "Identity".
As mentioned before, you get dedicated identities by registering at the Volkswagen IDK or create a service accounts.
Identities do not differ technical-wise, they can be used to call all CarNEO's API endpoints.
You can view your identity by utilizing the following endpoint.

GET /auth/own_identity

Identities must have appropriate roles assigned, otherwise the requests are rejected. Please see section Service Account to learn how to assign roles.