Configure authorization modes

For client authorization AppSync supports API Keys, Amazon IAM credentials, Amazon Cognito User Pools, and 3rd party OIDC providers. This is inferred from the amplifyconfiguration.json/.dart file when you call Amplify.configure(). You can configure auth modes for an API using the Amplify CLI or manual configuration.

Auth Modes

API key

API Key is the easiest way to setup and prototype your application with AWS AppSync. This means it is also prone to abuse since anyone can easily discover the API Key and make requests to your public service. To have authorization checks, use the other auth modes such as Cognito user pool or AWS IAM. API Key will expiry according to the expiry time set when provisioning AWS AppSync and will require extending it or creating a new one if needed. Default API Key expiry time is 7 days.

Amazon Cognito User Pools

Amazon Cognito User Pools is most commonly used with AWS AppSync when adding authorization check on your API calls. If your application needs to interact with other AWS services besides AWS AppSync, such as Amazon S3, you will need to use AWS IAM credentials with Amazon Cognito Identity Pools. Amplify CLI can automatically configure this for you and will also automatically use the authenticated user from User Pools to federate with the Identity Pools to provide the AWS IAM credentials in the application. See this for more information about the differences. This allows you to have both User Pools' credentials for AWS AppSync and AWS IAM credentials for other AWS resources. You can learn more about Amplify Auth outlined in the Accessing credentials section.

IAM

Amazon Cognito Identity Pools allows you to use credentials from AWS IAM in your app. AWS IAM helps you securely control access to AWS resources. You use IAM to control who is authenticated (signed in) and authorized (has permissions) to use AWS resources. Learn more about IAM . The Amplify CLI can automatically configure this for you.

OpenID Connect (OIDC)

If you are using a 3rd party OIDC provider you will need to configure it and manage the details of token refreshes yourself.

AWS Lambda

You can implement your own custom API authorization logic using an AWS Lambda function. To add a Lambda function as an authorization mode for your AppSync API, go to the Settings section of the AppSync console.

You will need to manage the details of token refreshes in your application code yourself.

Use Amplify CLI to configure authorization modes

Amplify CLI can automatically configure the auth modes for you when running amplify add api or amplify update api if you want to change the auth mode.

If you already have auth configured, then you need to run amplify update api to use this pre-configured auth mode and CLI will not ask for auth settings again.

1amplify update api

1? Please select from one of the below mentioned services:
2    > `GraphQL`
3? Select a setting to edit:
4    > `Authorization modes`
5? Choose the default authorization type for the API
6  API key
7  Amazon Cognito User Pool
8❯ IAM
9  OpenID Connect

Manual Configuration

API Key

Add the following snippet to your amplifyconfiguration.json/.dart file, under the awsAPIPlugin:

1{
2    ...
3    "awsAPIPlugin": {
4        "[YOUR-GRAPHQLENDPOINT-NAME]": {
5            "endpointType": "GraphQL",
6            "endpoint": "[GRAPHQL-ENDPOINT]",
7            "region": "[REGION]",
8            "authorizationType": "API_KEY",
9            "apiKey": "[API-KEY]"
10        }
11    }
12}

Amazon Cognito User Pools

Add the following snippet to your amplifyconfiguration.json/.dart file, under the awsCognitoAuthPlugin:

1{
2    ...
3    "awsCognitoAuthPlugin": {
4        "CognitoUserPool": {
5            "Default": {
6                "PoolId": "[POOL-ID]",
7                "AppClientId": "[APP-CLIENT-ID]",
8                "Region": "[REGION]"
9            }
10        }
11    }
12}

and under the awsAPIPlugin

1{
2    ...
3    "awsAPIPlugin": {
4        "[YOUR-GRAPHQLENDPOINT-NAME]": {
5            "endpointType": "GraphQL",
6            "endpoint": "[GRAPHQL-ENDPOINT]",
7            "region": "[REGION]",
8            "authorizationType": "AMAZON_COGNITO_USER_POOLS",
9        }
10    }
11}

In case you have not added the Cognito libraries to your application, be sure to add them:

1environment:
2   sdk: ">=2.18.0 <4.0.0"
3
4dependencies:
5  flutter:
6    sdk: flutter
7
8   amplify_flutter: ^1.0.0
9   amplify_api: ^1.0.0
10   # Be sure that this is added
11   amplify_auth_cognito: ^1.0.0

Afterwards add the following code to your app before you configure Amplify:

1await Amplify.addPlugins([
2  AmplifyAuthCognito(), 
3  AmplifyAPI(modelProvider: ModelProvider.instance),
4]);

IAM

Add the following snippet to your amplifyconfiguration.json/.dart file:

1{
2    ...
3    "awsCognitoAuthPlugin": {
4        "CredentialsProvider": {
5            "CognitoIdentity": {
6                "Default": {
7                    "PoolId": "[COGNITO-IDENTITY-POOLID]",
8                    "Region": "[REGION]"
9                }
10            }
11        }
12    }
13}

and under the awsAPIPlugin

1{
2    ...
3    "awsAPIPlugin": {
4        "[YOUR-GRAPHQLENDPOINT-NAME]": {
5            "endpointType": "GraphQL",
6            "endpoint": "[GRAPHQL-ENDPOINT]",
7            "region": "[REGION]",
8            "authorizationType": "AWS_IAM",
9        }
10    }
11}

OIDC

Update the amplifyconfiguration.json/.dart file and code snippet as follows:

1{
2    ...
3    "awsAPIPlugin": {
4        "[YOUR-GRAPHQLENDPOINT-NAME]": {
5            "endpointType": "GraphQL",
6            "endpoint": "[GRAPHQL-ENDPOINT]",
7            "region": "[REGION]",
8            "authorizationType": "OPENID_CONNECT",
9        }
10    }
11}

To start, create a provider class inheriting from OIDCAuthProvider.

1import 'package:amplify_api/amplify_api.dart';
2
3class CustomOIDCProvider extends OIDCAuthProvider {
4  const CustomOIDCProvider();
5
6  @override
7  Future<String?> getLatestAuthToken() async => '[OPEN-ID-CONNECT-TOKEN]';
8}

Then, include it, along with any other auth providers, in the call to addPlugin.

1await Amplify.addPlugin(
2  AmplifyAPI(
3    authProviders: const [
4      CustomOIDCProvider(),
5      CustomFunctionProvider(),
6    ],
7  ),
8);

Note: When using custom auth providers, getLatestAuthToken must be called before every API call, so it's important to minimize the amount of work this method performs. Consider caching your token in-memory so that it's available synchronously to the plugin, and only refresh it when necessary.

If you are using Cognito's user pool as the authorization type, this will by default retrieve and use the Access Token for your requests. If you would like to override this behavior and use the ID Token instead, you can treat Cognito user pool as your OIDC provider and use Amplify.Auth to retrieve the ID Token for your requests.

Change the custom provider to retrieve the current session:

1import 'package:amplify_api/amplify_api.dart';
2import 'package:amplify_auth_cognito/amplify_auth_cognito.dart';
3
4class CustomOIDCProvider extends OIDCAuthProvider {
5  const CustomOIDCProvider();
6
7  @override
8  Future<String?> getLatestAuthToken() async {
9    final session = await Amplify.Auth.fetchAuthSession() as CognitoAuthSession;
10    return session.userPoolTokens?.idToken;
11  }
12}

Then, include it, along with any other auth providers, in the call to addPlugin.

1await Amplify.addPlugin(
2  AmplifyAPI(
3    authProviders: const [
4      CustomOIDCProvider(),
5      CustomFunctionProvider(),
6    ],
7  ),
8);

AWS Lambda

Amplify CLI does not currently allow you to configure Lambda as an authorization mode for your GraphQL API. To add a Lambda function as an authorization mode for your AppSync API, go to the Settings section of the AppSync console. Then, update the authorizationType value in the amplifyconfiguration.json/.dart file and code snippet as follows:

1{
2    ...
3    "awsAPIPlugin": {
4        "[YOUR-GRAPHQLENDPOINT-NAME]": {
5            "endpointType": "GraphQL",
6            "endpoint": "[GRAPHQL-ENDPOINT]",
7            "region": "[REGION]",
8            "authorizationType": "AWS_LAMBDA",
9        }
10    }
11}

To start, create a provider class inheriting from FunctionAuthProvider.

1class CustomFunctionProvider extends FunctionAuthProvider {
2    const CustomFunctionProvider();
3
4    @override
5    Future<String?> getLatestAuthToken() async => '[AWS-LAMBDA-AUTH-TOKEN]';
6}

Then, include it, along with any other auth providers, in the call to addPlugin.

1await Amplify.addPlugin(
2  AmplifyAPI(
3    authProviders: const [
4      CustomOIDCProvider(),
5      CustomFunctionProvider(),
6    ],
7  ),
8);

NONE

You can also set authorization mode to NONE so that the library will not provide any request interception logic. You can use this when your API does not require any authorization or when you want to manipulate the request yourself, such as adding header values or authorization data.

1{
2    ...
3    "awsAPIPlugin": {
4        "[YOUR-GRAPHQLENDPOINT-NAME]": {
5            "endpointType": "GraphQL",
6            "endpoint": "[GRAPHQL-ENDPOINT]",
7            "region": "[REGION]",
8            "authorizationType": "NONE",
9        }
10    }
11}

You can register your own request interceptor to intercept the request and perform an action or inject something into your request before it is performed.

The simplest option for GraphQL requests is to use the headers property of a GraphQLRequest.

1Future<void> queryWithCustomHeaders() async {
2  final operation = Amplify.API.query<String>(
3    request: GraphQLRequest(
4      document: graphQLDocumentString,
5      headers: {'customHeader': 'someValue'},
6    ),
7  );
8  final response = await operation.response;
9  final data = response.data;
10  safePrint('data: $data');
11}

Another option is to use the baseHttpClient property of the API plugin which can customize headers or otherwise alter HTTP functionality for all HTTP calls.

1// First create a custom HTTP client implementation to extend HTTP functionality.
2class MyHttpRequestInterceptor extends AWSBaseHttpClient {
3  @override
4  Future<AWSBaseHttpRequest> transformRequest(
5    AWSBaseHttpRequest request,
6  ) async {
7    request.headers.putIfAbsent('customHeader', () => 'someValue');
8    return request;
9  }
10}
11
12// Then you can pass an instance of this client to `baseHttpClient` when you configure Amplify.
13await Amplify.addPlugins([
14  AmplifyAPI(baseHttpClient: MyHttpRequestInterceptor()),
15]);

Configure multiple authorization modes

There is currently a known issue where enabling multi-auth modes for the API plugin may break DataStore functionality if the DataStore plugin is also used in the same App.

If you are planning to enable multi-auth for only the DataStore plugin, please refer to the configure multiple authorization types section in DataStore documentation.

If you are planning to enable multi-auth for both the API and DataStore plugins, please monitor the aforementioned issue for the latest progress and updates.

This section talks about the capability of AWS AppSync to configure multiple authorization modes for a single AWS AppSync endpoint and region. Follow the AWS AppSync Multi-Auth to configure multiple authorization modes for your AWS AppSync endpoint.

You can now configure a single GraphQL API to deliver private and public data. Private data requires authenticated access using authorization mechanisms such as IAM, Cognito User Pools, and OIDC. Public data does not require authenticated access and is delivered through authorization mechanisms such as API Keys. You can also configure a single GraphQL API to deliver private data using more than one authorization type. For example, you can configure your GraphQL API to authorize some schema fields using OIDC, while other schema fields through Cognito User Pools and/or IAM.

As discussed in the above linked documentation, certain fields may be protected by different authorization types. This can lead the same query, mutation, or subscription to have different responses based on the authorization sent with the request; Therefore, it is recommended to use the different friendly_name_<AuthMode> as the apiName parameter in the Amplify.API call to reference each authorization type.

The following snippets highlight the new values in the amplifyconfiguration.json/.dart and the client code configurations.

The friendly_name illustrated here is created from Amplify CLI prompt. There are 4 clients in this configuration that connect to the same API except that they use different AuthMode.

1{
2  "UserAgent": "aws-amplify-cli/2.0",
3  "Version": "1.0",
4  "api": {
5    "plugins": {
6      "awsAPIPlugin": {
7        "[FRIENDLY-NAME-API-WITH-API-KEY]": {
8          "endpointType": "GraphQL",
9          "endpoint": "[GRAPHQL-ENDPOINT]",
10          "region": "[REGION]",
11          "authorizationType": "API_KEY",
12          "apiKey": "[API_KEY]"
13        },
14        "[FRIENDLY-NAME-API-WITH-IAM]": {
15          "endpointType": "GraphQL",
16          "endpoint": "[GRAPHQL-ENDPOINT]",
17          "region": "[REGION]",
18          "authorizationType": "AWS_IAM"
19        },
20        "[FRIENDLY-NAME-API-WITH-USER-POOLS]": {
21          "endpointType": "GraphQL",
22          "endpoint": "https://xyz.appsync-api.us-west-2.amazonaws.com/graphql",
23          "region": "[REGION]",
24          "authorizationType": "AMAZON_COGNITO_USER_POOLS"
25        },
26        "[FRIENDLY-NAME-API-WITH-OPENID-CONNECT]": {
27          "endpointType": "GraphQL",
28          "endpoint": "https://xyz.appsync-api.us-west-2.amazonaws.com/graphql",
29          "region": "[REGION]",
30          "authorizationType": "OPENID_CONNECT"
31        }
32      }
33    }
34  }
35}

The GRAPHQL-ENDPOINT from AWS AppSync will look similar to https://xyz.appsync-api.us-west-2.amazonaws.com/graphql.

When you have multiple authorization modes, you can specify the mode with the authorizationMode parameter. You can also specify the API name with the apiName parameter.

1Future<void> mutateWithApiKey() async {
2  final operation = Amplify.API.mutate<String>(
3    request: GraphQLRequest(
4      document: graphQLDocumentString,
5      authorizationMode: APIAuthorizationType.apiKey,
6    ),
7  );
8  final response = await operation.response;
9  final data = response.data;
10  safePrint('data: $data');
11}
12
13Future<void> mutateWithIam() async {
14  final operation = Amplify.API.mutate<String>(
15    request: GraphQLRequest(
16      document: graphQLDocumentString,
17      authorizationMode: APIAuthorizationType.iam,
18    ),
19  );
20  final response = await operation.response;
21  final data = response.data;
22  safePrint('data: $data');
23}
24
25Future<void> mutateByApiName() async {
26  final operation = Amplify.API.mutate<String>(
27    request: GraphQLRequest(
28      document: graphQLDocumentString,
29      apiName: '[FRIENDLY-NAME-API-WITH-API-KEY]',
30    ),
31  );
32  final response = await operation.response;
33  final data = response.data;
34  safePrint('data: $data');
35}

AppSync Concepts

Create, update, and delete application data