Last updated Dec 2, 2021

Rate this page:

Implement a dynamic profile retriever with external authentication

Before you begin

This guide assumes you're already familiar with calling an external OAuth 2.0 API using the Forge fetch function, with authentication handled by the Forge platform. If not, see the Use an external OAuth 2.0 API with fetch guide first.

Limitations

As you work with a dynamic profile retriever, keep in mind these limitations:

  • The file containing a dynamic profile retriever cannot import @forge/ui. When executed, the dynamic profile retriever is run in a different context outside of the UI.
  • The displayName attribute is displayed to the user to help distinguish between multiple accounts. You should not use the name of the user as this may be common across multiple accounts. Use something more specific, such as a username or email address instead.

Update the Forge function

  1. Create a new file called auth.ts in the src folder with the code shown below.
1
2
import { AuthProfile } from '@forge/response';

interface ProfileRetrieverParameters {
  status: number;
  body: {
    [key: string]: any;
  };
}

export const retriever = (response: ProfileRetrieverParameters): AuthProfile => {
  const { status, body: externalProfile } = response;

  if (status === 200){
    return new AuthProfile({
      id: externalProfile.id,
      displayName: externalProfile.email || externalProfile.name,
      avatarUrl: externalProfile.picture,
    });
  } else {
    throw new Error(`Could not determine profile information. HTTP ${status}`);
  }
}

See the AuthProfile reference documentation for more details.

Update the manifest

  1. Add the new function to the manifest.yml file.
1
2
modules:
  function:
    ...
    - key: google-profile
      handler: auth.retriever
  1. Change the retrieveProfile action to replace the resolvers with a function.
1
2
providers:
  auth:
    - key: google
      ...
      actions:
        ...
        retrieveProfile:
          remote: google-apis
          path: /userinfo/v2/me
          function: google-profile

See the Profile retriever reference for more details.

Deploy the changes

Navigate to the app's top-level directory and deploy your app with the manifest changes.

1
2
forge deploy

This causes a major version upgrade of your app. Users are required to upgrade to the latest version of the app.

Learn more about Forge versions.

Debug a profile retriever

Since the profile retriever is a Forge function, you can start a tunnel to troubleshoot issues by running:

1
2
forge tunnel

The AuthProfile class validates the parameters passed into its constructor and raises an exception in the logs.

Common errors

To assist your debugging, below are some common errors and fixes when implementing a dynamic profile retriever.

Could not retrieve profile information

Error message: could not retrieve profile information: There was an error invoking the function - Can't wrap a non-transferable value

Action: Check your function returns an AuthProfile class.

Rate this page: