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](https://aws.amazon.com/premiumsupport/knowledge-center/cognito-user-pools-identity-pools/). 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](/lib/auth/access_credentials). 

### 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](https://docs.aws.amazon.com/IAM/latest/UserGuide/introduction.html?icmpid=docs_iam_console) . 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.

```bash
amplify update api
```

```console
? Please select from one of the below mentioned services:
    > `GraphQL`
? Select a setting to edit:
    > `Authorization modes`
? Choose the default authorization type for the API
  API key
  Amazon Cognito User Pool
❯ IAM
  OpenID Connect
```

## Manual Configuration

### API Key

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

```json
{
    ...
    "awsAPIPlugin": {
        "[YOUR-GRAPHQLENDPOINT-NAME]": {
            "endpointType": "GraphQL",
            "endpoint": "[GRAPHQL-ENDPOINT]",
            "region": "[REGION]",
            "authorizationType": "API_KEY",
            "apiKey": "[API-KEY]"
        }
    }
}
```

### Amazon Cognito User Pools

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

```json
{
    ...
    "awsCognitoAuthPlugin": {
        "CognitoUserPool": {
            "Default": {
                "PoolId": "[POOL-ID]",
                "AppClientId": "[APP-CLIENT-ID]",
                "Region": "[REGION]"
            }
        }
    }
}
```
and under the `awsAPIPlugin`
```json
{
    ...
    "awsAPIPlugin": {
        "[YOUR-GRAPHQLENDPOINT-NAME]": {
            "endpointType": "GraphQL",
            "endpoint": "[GRAPHQL-ENDPOINT]",
            "region": "[REGION]",
            "authorizationType": "AMAZON_COGNITO_USER_POOLS",
        }
    }
}

```

import ios0 from "/src/fragments/lib/graphqlapi/ios/authz/10_userpool.mdx";

<Fragments fragments={{ios: ios0}} />

import android1 from "/src/fragments/lib/graphqlapi/android/authz/10_userpool.mdx";

<Fragments fragments={{android: android1}} />

import flutter2 from "/src/fragments/lib/graphqlapi/flutter/authz/10_userpool.mdx";

<Fragments fragments={{flutter: flutter2}} />

### IAM

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

```json
{
    ...
    "awsCognitoAuthPlugin": {
        "CredentialsProvider": {
            "CognitoIdentity": {
                "Default": {
                    "PoolId": "[COGNITO-IDENTITY-POOLID]",
                    "Region": "[REGION]"
                }
            }
        } 
    }
}
```
and under the `awsAPIPlugin`
```json
{
    ...
    "awsAPIPlugin": {
        "[YOUR-GRAPHQLENDPOINT-NAME]": {
            "endpointType": "GraphQL",
            "endpoint": "[GRAPHQL-ENDPOINT]",
            "region": "[REGION]",
            "authorizationType": "AWS_IAM",
        }
    }
}
```

### OIDC

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

```json
{
    ...
    "awsAPIPlugin": {
        "[YOUR-GRAPHQLENDPOINT-NAME]": {
            "endpointType": "GraphQL",
            "endpoint": "[GRAPHQL-ENDPOINT]",
            "region": "[REGION]",
            "authorizationType": "OPENID_CONNECT",
        }
    }
}
```

import ios3 from "/src/fragments/lib/graphqlapi/ios/authz/20_oidc.mdx";

<Fragments fragments={{ios: ios3}} />

import android4 from "/src/fragments/lib/graphqlapi/android/authz/20_oidc.mdx";

<Fragments fragments={{android: android4}} />

import flutter5 from "/src/fragments/lib/graphqlapi/flutter/authz/20_oidc.mdx";

<Fragments fragments={{flutter: flutter5}} />

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.

import ios6 from "/src/fragments/lib/graphqlapi/ios/authz/21_oidc.mdx";

<Fragments fragments={{ios: ios6}} />

import android7 from "/src/fragments/lib/graphqlapi/android/authz/21_oidc.mdx";

<Fragments fragments={{android: android7}} />

import flutter8 from "/src/fragments/lib/graphqlapi/flutter/authz/21_oidc.mdx";

<Fragments fragments={{flutter: flutter8}} />

### 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:

```json
{
    ...
    "awsAPIPlugin": {
        "[YOUR-GRAPHQLENDPOINT-NAME]": {
            "endpointType": "GraphQL",
            "endpoint": "[GRAPHQL-ENDPOINT]",
            "region": "[REGION]",
            "authorizationType": "AWS_LAMBDA",
        }
    }
}
```

import ios9 from "/src/fragments/lib/graphqlapi/ios/authz/22_lambda.mdx";

<Fragments fragments={{ios: ios9}} />

import android10 from "/src/fragments/lib/graphqlapi/android/authz/22_lambda.mdx";

<Fragments fragments={{android: android10}} />

import flutter11 from "/src/fragments/lib/graphqlapi/flutter/authz/22_lambda.mdx";

<Fragments fragments={{flutter: flutter11}} />

### 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.

```json
{
    ...
    "awsAPIPlugin": {
        "[YOUR-GRAPHQLENDPOINT-NAME]": {
            "endpointType": "GraphQL",
            "endpoint": "[GRAPHQL-ENDPOINT]",
            "region": "[REGION]",
            "authorizationType": "NONE",
        }
    }
}
```

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. 

import ios12 from "/src/fragments/lib/graphqlapi/ios/advanced-workflows/50_interceptor.mdx";

<Fragments fragments={{ios: ios12}} />

import android13 from "/src/fragments/lib/graphqlapi/android/advanced-workflows/50_interceptor.mdx";

<Fragments fragments={{android: android13}} />

import flutter14 from "/src/fragments/lib/graphqlapi/flutter/advanced-workflows/50_interceptor.mdx";

<Fragments fragments={{flutter: flutter14}} />

## Configure multiple authorization modes

<Callout warning>

There is currently [a known issue](https://github.com/aws-amplify/amplify-flutter/issues/1867) 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](/lib/datastore/setup-auth-rules/#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.

</Callout>

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](https://docs.aws.amazon.com/appsync/latest/devguide/security.html#using-additional-authorization-modes) 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`.

```json
{
    "UserAgent": "aws-amplify-cli/2.0",
    "Version": "1.0",
    "api": {
        "plugins": {
            "awsAPIPlugin": {
                "[FRIENDLY-NAME-API-WITH-API-KEY]": {
                    "endpointType": "GraphQL",
                    "endpoint": "[GRAPHQL-ENDPOINT]",
                    "region": "[REGION]",
                    "authorizationType": "API_KEY",
                    "apiKey": "[API_KEY]"
                },
                "[FRIENDLY-NAME-API-WITH-IAM]": {
                    "endpointType": "GraphQL",
                    "endpoint": "[GRAPHQL-ENDPOINT]",
                    "region": "[REGION]",
                    "authorizationType": "AWS_IAM",
                },
                "[FRIENDLY-NAME-API-WITH-USER-POOLS]": {
                    "endpointType": "GraphQL",
                    "endpoint": "https://xyz.appsync-api.us-west-2.amazonaws.com/graphql",
                    "region": "[REGION]",
                    "authorizationType": "AMAZON_COGNITO_USER_POOLS",
                },
                "[FRIENDLY-NAME-API-WITH-OPENID-CONNECT]": {
                    "endpointType": "GraphQL",
                    "endpoint": "https://xyz.appsync-api.us-west-2.amazonaws.com/graphql",
                    "region": "[REGION]",
                    "authorizationType": "OPENID_CONNECT",
                }
            }
        }
    }
}
```

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

import ios15 from "/src/fragments/lib/graphqlapi/ios/authz/30_multi.mdx";

<Fragments fragments={{ios: ios15}} />

import android16 from "/src/fragments/lib/graphqlapi/android/authz/30_multi.mdx";

<Fragments fragments={{android: android16}} />

import flutter17 from "/src/fragments/lib/graphqlapi/flutter/authz/30_multi.mdx";

<Fragments fragments={{flutter: flutter17}} />
