Using a JSON Web Token (JWT) with a public key

The following examples show how to use JSON Web Token (JWT) with a public key for user access control when you create an index. For more information about JWT, see jwt.io.

Console

1. Choose Create index to start creating a new index.

2. On the Specify index details page, give your index a name and a description.

3. For IAM role, select a role or select Create a new role to and specify a role name to create a new role. The IAM role will have the prefix "AmazonKendra-".

4. Leave all of the other fields at their defaults. Choose Next.

5. In the Configure user access control page, under Access control settings, choose Yes to use tokens for access control.

6. Under Token configuration, select JWT with public key as the Token type.

7. Under Parameters for signing public key, choose the Type of secret. You can use an existing AWS Secrets Manager secret or create a new secret.

   To create a new secret, choose New and then follow these steps:

   1. Under New AWS Secrets Manager secret, specify a Secret name. The prefix AmazonKendra- will be added when you save the public key.

   2. Specify a Key ID. The key id is a hint that indicates which key was used to secure the JSON web signature of the token.

   3. Choose the signing Algorithm for the token. This is the cryptographic algorithm used to secure the ID token. For more information on RSA, see RSA Cryptography.

   4. Under Certificate attributes, specify an optional Certificate chain. The certificate chain is made up of a list of certificates. It begins with a server’s certificate and terminates with the root certificate.

   5. Optional Specify the Thumbprint or fingerprint. It should be is a hash of a certificate, computed over all certificate data and its signature.

   6. Specify the Exponent. This is the exponent value for the RSA public key. It is represented as a Base64urlUInt-encoded value.

   7. Specify the Modulus. This is the exponent value for the RSA public key. It is represented as a Base64urlUInt-encoded value.

   8. Select Save key to save the new key.

8. Optional Under Advanced configuration:

   1. Specify a Username to use in the ACL check.

   2. Specify one or more Groups to use in the ACL check.

   3. Specify the Issuer that will validate the token issuer.

   4. Specify the Client Id(s). You must specify a regular expression that match the audience in the JWT.

9. In the Provisioning details page, choose Developer edition.

10. Choose Create to create your index.

11. Wait for your index to be created. Amazon Kendra provisions the hardware for your index. This operation can take some time.

CLI

You can use JWT with a public key inside of a AWS Secrets Manager. You need the Secrets Manager ARN, and your Amazon Kendra role must have access to GetSecretValue on the Secrets Manager resource. If you are encrypting the Secrets Manager resource with AWS KMS, the role must also have access to the decrypt action.

To create an index with the AWS CLI using a JSON input file, first create a JSON file with your desired parameters:

{
    "Name": "user-context",
    "Edition": "ENTERPRISE_EDITION",
    "RoleArn": "arn:aws:iam::account id:role:/my-role",
    "UserTokenConfigurationList": [
        {
            "JwtTokenTypeConfiguration": {
                "KeyLocation": "SECRET_MANAGER",
                "Issuer": "optional: specify the issuer url",
                "ClaimRegex": "optional: regex to validate claims in the token",
                "UserNameAttributeField": "optional: user",
                "GroupAttributeField": "optional: group",
                "SecretManagerArn": "arn:aws:secretsmanager:us-west-2:account id:secret:/my-user-context-secret
            }
        }
    ],    "UserContextPolicy": "USER_TOKEN"
}

You can override the default user and group field names. The default value for UserNameAttributeField is "user". The default value for GroupAttributeField is "groups".

Next, call create-index using the input file. For example, if the name of your JSON file is create-index-openid.json, you can use the following:

aws kendra create-index --cli-input-json file://create-index-openid.json

The secret must have the following format in Secrets Manager:

{
  "keys": [
    {
      "alg": "RS256|RS384|RS512",
      "kty": "RSA", //this can be RSA only for now
      "use": "sig", //this value can be sig only for now
      "n": "modulus of standard pem",
      "e": "exponent of standard pem",
      "kid": "key_id",
      "x5t": "certificate thumprint for x.509 cert",
      "x5c": [
        "certificate chain"
      ]
    }
  ]
}

For more information about JWT, see jwt.io.

Python

response = kendra.create_index(
    Name='user-context',
    Edition='ENTERPRISE_EDITION',
    RoleArn='arn:aws:iam::account id:role:/my-role',
    UserTokenConfigurationList=[
        {
            "JwtTokenTypeConfiguration": {
                "KeyLocation": "URL",
                "Issuer": "optional: specify the issuer url",
                "ClaimRegex": "optional: regex to validate claims in the token",
                "UserNameAttributeField": "optional: user",
                "GroupAttributeField": "optional: group",
                "SecretManagerArn": "arn:aws:secretsmanager:us-west-2:account id:secret:/my-user-context-secret"
            }
        }
    ],
    UserContextPolicy='USER_TOKEN'
)