Sign in
Authentication

🛡️ Log into a Cardinal app.

Logs the user into a client application that is hosted (bundled web app) or served by this server.

If logging into the Guest Account, no credentials are required. If logging into a Cardinal Account, a valid Cardinal SSO token is required.

The client app <strong>must</strong> set the <code>cardinal-app</code> header for this request.

Only the capability corresponding to the application that you are trying to log into will be validated.<br /><hr /><h3>🛡️ Requires one of these Capabilities: <code>AdminApp.Login</code> <code>MusicApp.Login</code> <code>PhotosApp.Login</code> <code>CinemaApp.Login</code></h3>

post/api/v1/auth/login

Headers

cardinal-app'admin' | 'music' | 'photos' | 'cinema'

Request body

userIdstring
usernamestring
passwordstring
cardinalJWTstring

Response

JWTstring required
userobject required
cloudJWTstring
cloudUserobject
refreshTokenstring
scopeobject

Changes

Changed in 3 of the 176 revisions of this API.113

  • fd25cc21a89e12See the full diff
    • ●

      removed the optional property refreshTolkien from the response with the 201 status

      response-optional-property-removed

    • ○

      added the optional property refreshToken to the response with the 201 status

      response-optional-property-added

    • ○

      added the optional property scope to the response with the 201 status

      response-optional-property-added

  • 503a10ab48c21See the full diff
    • ○

      endpoint added

      endpoint-added

  • 1ec5a2e9d0391See the full diff
    • ▲

      api path removed without deprecation

      api-path-removed-without-deprecation

    This revision also has 4 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog