Sign in with MaxwellTrack
Let people sign in to your app with their MaxwellTrack account. It is standard OpenID Connect, so any OAuth 2.0 library works, and the person's password never reaches your app.
Register your app
- 1
Create the application
In the console, open Developer and choose New application.
- 2
Add callback addresses
Where people return after approving. They must match exactly, so add one for each environment, development included. Mobile schemes such as
com.example.fleet://oauth/callbackwork. - 3
Choose permissions
Ask only for what your app uses. Each one is a line the person reads before approving.
- 4
Copy the client ID
A server application also gets a client secret, shown once. Browser and mobile apps get no secret and use PKCE instead.
Test sign-in on the application's page runs the real flow with your settings, so you can check the callback address and permissions before writing code.
Discovery
Give this address to your OAuth library and it finds every endpoint and the signing keys on its own.
https://maxwelltrack.com/api/oauth/.well-known/openid-configurationEndpoints
| Endpoint | Address |
|---|---|
| Authorization | https://maxwelltrack.com/oauth/authorize |
| Token | https://maxwelltrack.com/api/oauth/token |
| User info | https://maxwelltrack.com/api/oauth/userinfo |
| Signing keys | https://maxwelltrack.com/api/oauth/jwks.json |
| Revocation | https://maxwelltrack.com/api/oauth/revoke |
Scopes
| Scope | The person agrees to share |
|---|---|
openid | Who they are. Always required. |
profile | Their name and profile photo. |
email | Their email address. |
devices:read, devices:write and telemetry:read can be requested and appear on the approval screen, but no MaxwellTrack API accepts them yet. Leave them out until your app has a use for them.
Claims
substringThe account's permanent id. Use it as your user key: it never changes, while an email address can.
namestringWith the
profilescope.picturestringProfile photo address, with the
profilescope.emailstringWith the
emailscope.email_verifiedbooleanWith the
emailscope.
Rules the provider enforces
- Authorization code flow with PKCE,
S256only. - Callback addresses match exactly.
https://app.example.com/callbackdoes not accept a return tohttps://app.example.com/callback/. - Codes are single use. A code presented twice revokes every token the app holds for that person.
- Refresh tokens rotate. Each refresh returns a new refresh token; store it and discard the old one.
- ID tokens are signed with RS256. Verify them against the published keys.
- Approval is remembered. When a person disconnects your app from their account, its tokens stop working.
Never put a client secret in an app people download
Anything shipped to a browser or a phone can be read, so a secret in it is a published secret. Register those apps as public clients: they prove themselves with PKCE instead.
Something unclear or out of date on this page? Tell support.
