Authentication for FileMaker Cloud

FileMaker Admin API uses an access token to define a connection to the host. The token is valid either until it is invalidated using the Invalidate Access Token call or for 15 minutes after the last call that specified the token. (While the token is valid, each call that specifies the token resets the session timeout counter to zero.)

To authenticate accounts for FileMaker Cloud:

1. Generate the Claris ID token. See Claris Customer Console Help.
2. Include the Claris ID token from step 1 in the authentication call or any other calls to generate an access token.

   For example, use the following URL and header for the authentication call:

   • URL: https://host/fmi/admin/api/v2/user/auth

     where host is the host name or IP address of the virtual server running FileMaker Cloud.

   • Header: Authorization FMID Claris_ID_Token

   If you use the authentication call, the access token is returned in the response body. If you use other calls, the token is returned in the X-FM-Access-Token field in the response header.

3. For subsequent API calls, include the following Authorization header for the authentication call:

   Header: Authorization Bearer access token

Notes 

• Each time you use the Claris ID Authentication scheme to get an access token, a new API session is created. To avoid having multiple API sessions, use the same access token with the Bearer Authentication scheme for all API calls.

• To use FileMaker API calls with FileMaker Cloud, you must first authenticate using your Claris ID account and retrieve required session tokens. The tokens are valid for one hour. If it has been more than an hour since the last Claris ID authentication, API calls may fail with a 401 error. To resolve the issue, authenticate again using the Claris ID account and retrieve new session tokens.

• To authenticate accounts for uploading apps to FileMaker Cloud or updating a custom app based on changes in a clone, see Authentication for FileMaker Cloud API calls to upload or update apps.