Applications

Learn what each application type in the Console is for, how it authenticates, and what it may call.

An application is an OAuth client of your project: an id and a secret that your own software holds. Create one in the Console under Applications, in the project and environment you work in. The type you pick sets what its secret can do.

TypeIts secret signs in asUse it for
DefaultFull access for the project's own; nothing for one you addYour app's client id for user sign-ins
Social loginNothingGoogle or Apple sign-in for your users
AdminA project adminServer-to-server calls with full access
ManagerA Signals managerRunning your Signals tenant
SubmitterA Signals submitterPosting readings to Signals

A secret is shown in the Console, so keep it on your server. Never ship it in a browser or mobile app.

Applications are for software

An application type says what a piece of software may do, never who a person is. People sign in as themselves:

  • Your team are the project's admins, added and removed on the Console's Members page. See Invite a project admin.
  • Your users are the practitioners and patients of your app. They sign in through your app with its client id, and their access policies set what they may do.

Default

The client id your app sends when its users sign in, by password, TAN or another method. Your app needs only the id, never the secret.

The project's Default client secret has full access to your project's data. Never ship it in a browser or mobile app.

Every project comes with a Default client, named after the project. Its membership of the project has no access policy, and no access policy means full access. With its id and secret, as HTTP Basic or exchanged with client_credentials, a caller can read and write every FHIR resource of the project. Only client secrets are hidden from it: the FHIR API returns a ClientApplication's secret and retiringSecret to project admins alone.

A Default client you add on the Applications page has no membership: its secret signs in as nothing.

Social login

A default client with Google or Apple sign-ins set up. Each sign-in has an internal id your app sends, the provider's OAuth client id, and the provider (google or apple). Your users sign in, and they get their own sessions. Keep its secret on your server like any other.

Admin

A client with an admin membership of the project. Its id and secret sign in as the project admin and pass every access check, so it can call anything an admin can.

  • Authenticates with its id and secret as HTTP Basic on routes that accept it, or exchanged for a token with client_credentials at POST /oauth2/token. See Authenticate for both.
  • Use it only when no narrower type fits. The Console asks you to confirm before it creates one.

Manager

A client that acts as Signals' manager through /v1/signals/api. Its access policy holds exactly the signals_* capabilities that role needs: every route except posting readings.

  • Authenticates with its id and secret, as for an admin client. It never gets the admin bypass, so only its own capabilities count.
  • Needs a project with its own Signals tenant. On the shared tenant, creating one answers 409.
  • Details: App types and Signals route policies.

Submitter

A client that acts as Signals' submitter: it posts readings and reads patients. Use one for each gateway or service that sends readings.

Integration

The API can also create an integration client, which the Console does not offer. It reads and writes the project's Patient and Observation resources and reads DetectedIssue and Flag, and reaches no Signals route.

See also

Last updated on

On this page