Authentication

The API accepts 2 different authentication methods:

Oauth2

Every request needs an access token, sent as Authorization: Bearer {access_token}. A token grants access to any resource its user can access and expires after expires_in seconds (currently 3600); cache and reuse it until then.

Get a token from POST /oauth/token using any supported grant type:

  • JWT bearer (urn:ietf:params:oauth:grant-type:jwt-bearer) - recommended for API apps. Sign a short-lived JWT with the API app's client key and secret and exchange it for a token; no user interaction. OpenAPI cannot describe this grant as a flow, so it is documented on the Request Access Token operation.
  • Password - exchange an iFormBuilder username and password, plus the API app's client key and secret.
  • Authorization code - send the user to the authorize page on their iFormBuilder server, then exchange the returned code. access_type=offline also returns a refresh token.
  • Refresh token - exchange a refresh token from an offline authorization code grant for a new access token.