[ aws . apigateway ]

create-authorizer

Description

Adds a new Authorizer resource to an existing RestApi resource.

See also: AWS API Documentation

Synopsis

  create-authorizer
--rest-api-id <value>
--name <value>
--type <value>
[--provider-arns <value>]
[--auth-type <value>]
[--authorizer-uri <value>]
[--authorizer-credentials <value>]
[--identity-source <value>]
[--identity-validation-expression <value>]
[--authorizer-result-ttl-in-seconds <value>]
[--jwt-configuration <value>]
[--cli-input-json | --cli-input-yaml]
[--generate-cli-skeleton <value>]
[--debug]
[--endpoint-url <value>]
[--no-verify-ssl]
[--no-paginate]
[--output <value>]
[--query <value>]
[--profile <value>]
[--region <value>]
[--version <value>]
[--color <value>]
[--no-sign-request]
[--ca-bundle <value>]
[--cli-read-timeout <value>]
[--cli-connect-timeout <value>]
[--cli-binary-format <value>]
[--no-cli-pager]
[--cli-auto-prompt]
[--no-cli-auto-prompt]
[--cli-error-format <value>]
[--help]

Options

--rest-api-id (string) [required]

The string identifier of the associated RestApi.

--name (string) [required]

The name of the authorizer.

--type (string) [required]

The authorizer type. Valid values are TOKEN for a Lambda function using a single authorization token submitted in a custom header, REQUEST for a Lambda function using incoming request parameters, COGNITO_USER_POOLS for using an Amazon Cognito user pool, and JWT for using a native JWT authorizer with the trusted issuers, audiences, and signing algorithms that you declare.

Possible values:

  • TOKEN
  • REQUEST
  • COGNITO_USER_POOLS
  • JWT

--provider-arns (list)

A list of the Amazon Cognito user pool ARNs for the COGNITO_USER_POOLS authorizer. Each element is of this format: arn:aws:cognito-idp:{region}:{account_id}:userpool/{user_pool_id} . For a TOKEN or REQUEST authorizer, this is not defined. This property is not supported for JWT authorizers.

(string)

Syntax:

"string" "string" ...

--auth-type (string)

Optional customer-defined field, used in OpenAPI imports and exports without functional impact.

--authorizer-uri (string)

Specifies the authorizer’s Uniform Resource Identifier (URI). For TOKEN or REQUEST authorizers, this must be a well-formed Lambda function URI, for example, arn:aws:apigateway:us-west-2:lambda:path/2015-03-31/functions/arn:aws:lambda:us-west-2:{account_id}:function:{lambda_function_name}/invocations . In general, the URI has this form arn:aws:apigateway:{region}:lambda:path/{service_api} , where {region} is the same as the region hosting the Lambda function, path indicates that the remaining substring in the URI should be treated as the path to the resource, including the initial / . For Lambda functions, this is usually of the form /2015-03-31/functions/[FunctionARN]/invocations . This property is not supported for JWT authorizers.

--authorizer-credentials (string)

Specifies the required credentials as an IAM role for API Gateway to invoke the authorizer. To specify an IAM role for API Gateway to assume, use the role’s Amazon Resource Name (ARN). To use resource-based permissions on the Lambda function, specify null. This property is not supported for JWT authorizers.

--identity-source (string)

The identity source for which authorization is requested. For a TOKEN or COGNITO_USER_POOLS authorizer, this is required and specifies the request header mapping expression for the custom header holding the authorization token submitted by the client. For example, if the token header name is Auth , the header mapping expression is method.request.header.Auth . For the REQUEST authorizer, this is required when authorization caching is enabled. The value is a comma-separated string of one or more mapping expressions of the specified request parameters. For example, if an Auth header, a Name query string parameter are defined as identity sources, this value is method.request.header.Auth, method.request.querystring.Name . These parameters will be used to derive the authorization caching key and to perform runtime validation of the REQUEST authorizer by verifying all of the identity-related request parameters are present, not null and non-empty. Only when this is true does the authorizer invoke the authorizer Lambda function, otherwise, it returns a 401 Unauthorized response without calling the Lambda function. The valid value is a string of comma-separated mapping expressions of the specified request parameters. When the authorization caching is not enabled, this property is optional. For a JWT authorizer, this is required and must be a single request-header mapping expression, method.request.header.<name> , for example, method.request.header.Authorization . Query string parameters are not supported, and there is no default.

--identity-validation-expression (string)

A validation expression for the incoming identity token. For TOKEN authorizers, this value is a regular expression. For COGNITO_USER_POOLS authorizers, API Gateway will match the aud field of the incoming token from the client against the specified regular expression. It will invoke the authorizer’s Lambda function when there is a match. Otherwise, it will return a 401 Unauthorized response without calling the Lambda function. The validation expression does not apply to the REQUEST or JWT authorizer.

--authorizer-result-ttl-in-seconds (integer)

The TTL in seconds of cached authorizer results. If it equals 0, authorization caching is disabled. If it is greater than 0, API Gateway will cache authorizer responses. If this field is not set, the default value is 300. The maximum value is 3600, or 1 hour. This property is not supported for JWT authorizers.

--jwt-configuration (structure)

The configuration for a JWT authorizer. Required for JWT authorizers.

issuers -> (list) [required]

The issuers that the authorizer trusts. Issuer URLs must be unique.

(structure)

A trusted issuer in the JWT configuration.

issuer -> (string) [required]

The OpenID Connect (OIDC) issuer URL. The value must be an absolute https URL that includes a host and has no user information, query, or fragment. It must exactly match the iss claim of the token, and the issuer’s OIDC discovery document must name this exact issuer.

audiences -> (list) [required]

The audiences that the issuer can issue tokens for. None can be empty. The token’s aud claim must contain at least one of these values.

(string)

additionalClaims -> (list)

The additional claim rules for this issuer. Claim names must be unique within the issuer.

(structure)

An additional claim rule for an issuer.

claimName -> (string) [required]

The name of the claim to check. The value cannot be empty and cannot be iss , aud , exp , nbf , iat , scope , or scp .

format -> (string) [required]

The format of the claim value. The only valid value is SINGLE_STRING .

Possible values:

  • SINGLE_STRING

required -> (boolean)

Specifies whether the claim must be present in the token. Defaults to false . When true , the token must contain the claim.

expectedValues -> (list)

The accepted value for the claim. The value cannot be empty. When a value is specified, the claim must match it exactly, and the match is case-sensitive. When no value is specified, the claim only has to be present.

(string)

defaultAlgorithms -> (list) [required]

The signing algorithms that the authorizer accepts, applied to every issuer. Valid values are RS256 , RS384 , RS512 , ES256 , ES384 , and ES512 .

(string)

A JSON Web Signature (JWS) signing algorithm. Valid values are RS256 , RS384 , RS512 , ES256 , ES384 , and ES512 . HMAC (HS256 , HS384 , HS512 ) and none are not valid values.

Possible values:

  • RS256
  • RS384
  • RS512
  • ES256
  • ES384
  • ES512

JSON Syntax:

{
  "issuers": [
    {
      "issuer": "string",
      "audiences": ["string", ...],
      "additionalClaims": [
        {
          "claimName": "string",
          "format": "SINGLE_STRING",
          "required": true|false,
          "expectedValues": ["string", ...]
        }
        ...
      ]
    }
    ...
  ],
  "defaultAlgorithms": ["RS256"|"RS384"|"RS512"|"ES256"|"ES384"|"ES512", ...]
}

--cli-input-json | --cli-input-yaml (string) Reads arguments from the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, those values will override the JSON-provided values. It is not possible to pass arbitrary binary values using a JSON-provided value as the string will be taken literally. This may not be specified along with --cli-input-yaml.

--generate-cli-skeleton (string) Prints a JSON skeleton to standard output without sending an API request. If provided with no value or the value input, prints a sample input JSON that can be used as an argument for --cli-input-json. Similarly, if provided yaml-input it will print a sample input YAML that can be used with --cli-input-yaml. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command. The generated JSON skeleton is not stable between versions of the AWS CLI and there are no backwards compatibility guarantees in the JSON skeleton generated.

Global Options

--debug (boolean)

Turn on debug logging.

--endpoint-url (string)

Override command’s default URL with the given URL.

--no-verify-ssl (boolean)

By default, the AWS CLI uses SSL when communicating with AWS services. For each SSL connection, the AWS CLI will verify SSL certificates. This option overrides the default behavior of verifying SSL certificates.

--no-paginate (boolean)

Disable automatic pagination. If automatic pagination is disabled, the AWS CLI will only make one call, for the first page of results.

--output (string)

The formatting style for command output.

  • json
  • text
  • table
  • yaml
  • yaml-stream
  • off

--query (string)

A JMESPath query to use in filtering the response data.

--profile (string)

Use a specific profile from your credential file.

--region (string)

The region to use. Overrides config/env settings.

--version (string)

Display the version of this tool.

--color (string)

Turn on/off color output.

  • on
  • off
  • auto

--no-sign-request (boolean)

Do not sign requests. Credentials will not be loaded if this argument is provided.

--ca-bundle (string)

The CA certificate bundle to use when verifying SSL certificates. Overrides config/env settings.

--cli-read-timeout (int)

The maximum socket read time in seconds. If the value is set to 0, the socket read will be blocking and not timeout. The default value is 60 seconds.

--cli-connect-timeout (int)

The maximum socket connect time in seconds. If the value is set to 0, the socket connect will be blocking and not timeout. The default value is 60 seconds.

--cli-binary-format (string)

The formatting style to be used for binary blobs. The default format is base64. The base64 format expects binary blobs to be provided as a base64 encoded string. The raw-in-base64-out format preserves compatibility with AWS CLI V1 behavior and binary values must be passed literally. When providing contents from a file that map to a binary blob fileb:// will always be treated as binary and use the file contents directly regardless of the cli-binary-format setting. When using file:// the file contents will need to properly formatted for the configured cli-binary-format.

  • base64
  • raw-in-base64-out

--no-cli-pager (boolean)

Disable cli pager for output.

--cli-auto-prompt (boolean)

Automatically prompt for CLI input parameters.

--no-cli-auto-prompt (boolean)

Disable automatically prompt for CLI input parameters.

--cli-error-format (string)

The formatting style for error output. By default, errors are displayed in enhanced format.

  • legacy
  • json
  • yaml
  • text
  • table
  • enhanced

--help (boolean)

Display help for the command/subcommand.

Examples

Note

To use the following examples, you must have the AWS CLI installed and configured. See the Getting started guide in the AWS CLI User Guide for more information.

Unless otherwise stated, all examples have unix-like quotation rules. These examples will need to be adapted to your terminal’s quoting rules. See Using quotation marks with strings in the AWS CLI User Guide .

Example 1: To create a token-based API Gateway Custom Authorizer for the API

The following create-authorizer example creates a token-based authorizer.

aws apigateway create-authorizer \
    --rest-api-id 1234123412 \
    --name 'First_Token_Custom_Authorizer' \
    --type TOKEN \
    --authorizer-uri 'arn:aws:apigateway:us-west-2:lambda:path/2015-03-31/functions/arn:aws:lambda:us-west-2:123456789012:function:customAuthFunction/invocations' \
    --identity-source 'method.request.header.Authorization' \
    --authorizer-result-ttl-in-seconds 300

Output:

{
    "authType": "custom",
    "name": "First_Token_Custom_Authorizer",
    "authorizerUri": "arn:aws:apigateway:us-west-2:lambda:path/2015-03-31/functions/arn:aws:lambda:us-west-2:123456789012:function:customAuthFunction/invocations",
    "authorizerResultTtlInSeconds": 300,
    "identitySource": "method.request.header.Authorization",
    "type": "TOKEN",
    "id": "z40xj0"
}

For more information, see Use API Gateway Lambda authorizers in the Amazon API Gateway Developer Guide.

Example 2: To create a Cognito User Pools based API Gateway Custom Authorizer for the API

The following create-authorizer example creates a Cognito User Pools based API Gateway Custom Authorizer.

aws apigateway create-authorizer \
    --rest-api-id 1234123412 \
    --name 'First_Cognito_Custom_Authorizer' \
    --type COGNITO_USER_POOLS \
    --provider-arns 'arn:aws:cognito-idp:us-west-2:123456789012:userpool/us-west-2_aWcZeQbuD' \
    --identity-source 'method.request.header.Authorization'

Output:

{
    "authType": "cognito_user_pools",
    "identitySource": "method.request.header.Authorization",
    "name": "First_Cognito_Custom_Authorizer",
    "providerARNs": [
        "arn:aws:cognito-idp:us-west-2:123456789012:userpool/us-west-2_aWcZeQbuD"
    ],
    "type": "COGNITO_USER_POOLS",
    "id": "5yid1t"
}

For more information, see Control access to REST APIs using Amazon Cognito user pools as an authorizer in the Amazon API Gateway Developer Guide.

Example 3: To create a request-based API Gateway Custom Authorizer for the API

The following create-authorizer example creates a request-based authorizer.

aws apigateway create-authorizer \
    --rest-api-id 1234123412 \
    --name 'First_Request_Custom_Authorizer' \
    --type REQUEST \
    --authorizer-uri 'arn:aws:apigateway:us-west-2:lambda:path/2015-03-31/functions/arn:aws:lambda:us-west-2:123456789012:function:customAuthFunction/invocations' \
    --identity-source 'method.request.header.Authorization,context.accountId' \
    --authorizer-result-ttl-in-seconds 300

Output:

{
    "id": "z40xj0",
    "name": "First_Request_Custom_Authorizer",
    "type": "REQUEST",
    "authType": "custom",
    "authorizerUri": "arn:aws:apigateway:us-west-2:lambda:path/2015-03-31/functions/arn:aws:lambda:us-west-2:123456789012:function:customAuthFunction/invocations",
    "identitySource": "method.request.header.Authorization,context.accountId",
    "authorizerResultTtlInSeconds": 300
}

For more information, see Use API Gateway Lambda authorizers in the Amazon API Gateway Developer Guide.

Output

id -> (string)

The identifier for the authorizer resource.

name -> (string)

The name of the authorizer.

type -> (string)

The authorizer type. Valid values are TOKEN for a Lambda function using a single authorization token submitted in a custom header, REQUEST for a Lambda function using incoming request parameters, COGNITO_USER_POOLS for using an Amazon Cognito user pool, and JWT for using a native JWT authorizer with the trusted issuers, audiences, and signing algorithms that you declare.

Possible values:

  • TOKEN
  • REQUEST
  • COGNITO_USER_POOLS
  • JWT

providerARNs -> (list)

A list of the Amazon Cognito user pool ARNs for the COGNITO_USER_POOLS authorizer. Each element is of this format: arn:aws:cognito-idp:{region}:{account_id}:userpool/{user_pool_id} . For a TOKEN or REQUEST authorizer, this is not defined. This property is not supported for JWT authorizers.

(string)

authType -> (string)

Optional customer-defined field, used in OpenAPI imports and exports without functional impact.

authorizerUri -> (string)

Specifies the authorizer’s Uniform Resource Identifier (URI). For TOKEN or REQUEST authorizers, this must be a well-formed Lambda function URI, for example, arn:aws:apigateway:us-west-2:lambda:path/2015-03-31/functions/arn:aws:lambda:us-west-2:{account_id}:function:{lambda_function_name}/invocations . In general, the URI has this form arn:aws:apigateway:{region}:lambda:path/{service_api} , where {region} is the same as the region hosting the Lambda function, path indicates that the remaining substring in the URI should be treated as the path to the resource, including the initial / . For Lambda functions, this is usually of the form /2015-03-31/functions/[FunctionARN]/invocations . This property is not supported for JWT authorizers.

authorizerCredentials -> (string)

Specifies the required credentials as an IAM role for API Gateway to invoke the authorizer. To specify an IAM role for API Gateway to assume, use the role’s Amazon Resource Name (ARN). To use resource-based permissions on the Lambda function, specify null. This property is not supported for JWT authorizers.

identitySource -> (string)

The identity source for which authorization is requested. For a TOKEN or COGNITO_USER_POOLS authorizer, this is required and specifies the request header mapping expression for the custom header holding the authorization token submitted by the client. For example, if the token header name is Auth , the header mapping expression is method.request.header.Auth . For the REQUEST authorizer, this is required when authorization caching is enabled. The value is a comma-separated string of one or more mapping expressions of the specified request parameters. For example, if an Auth header, a Name query string parameter are defined as identity sources, this value is method.request.header.Auth , method.request.querystring.Name . These parameters will be used to derive the authorization caching key and to perform runtime validation of the REQUEST authorizer by verifying all of the identity-related request parameters are present, not null and non-empty. Only when this is true does the authorizer invoke the authorizer Lambda function, otherwise, it returns a 401 Unauthorized response without calling the Lambda function. The valid value is a string of comma-separated mapping expressions of the specified request parameters. When the authorization caching is not enabled, this property is optional. For a JWT authorizer, this is required and must be a single request-header mapping expression, method.request.header.<name> , for example, method.request.header.Authorization . Query string parameters are not supported, and there is no default.

identityValidationExpression -> (string)

A validation expression for the incoming identity token. For TOKEN authorizers, this value is a regular expression. For COGNITO_USER_POOLS authorizers, API Gateway will match the aud field of the incoming token from the client against the specified regular expression. It will invoke the authorizer’s Lambda function when there is a match. Otherwise, it will return a 401 Unauthorized response without calling the Lambda function. The validation expression does not apply to the REQUEST or JWT authorizer.

authorizerResultTtlInSeconds -> (integer)

The TTL in seconds of cached authorizer results. If it equals 0, authorization caching is disabled. If it is greater than 0, API Gateway will cache authorizer responses. If this field is not set, the default value is 300. The maximum value is 3600, or 1 hour. This property is not supported for JWT authorizers.

jwtConfiguration -> (structure)

The configuration returned for a JWT authorizer. This field is present only when type is JWT .

issuers -> (list)

The trusted issuers configured for the authorizer.

(structure)

A trusted issuer in the returned JWT configuration.

issuer -> (string)

The OpenID Connect (OIDC) issuer URL.

audiences -> (list)

The audiences that the issuer can issue tokens for.

(string)

additionalClaims -> (list)

The additional claim rules configured for this issuer.

(structure)

An additional claim rule for an issuer.

claimName -> (string) [required]

The name of the claim to check. The value cannot be empty and cannot be iss , aud , exp , nbf , iat , scope , or scp .

format -> (string) [required]

The format of the claim value. The only valid value is SINGLE_STRING .

Possible values:

  • SINGLE_STRING

required -> (boolean)

Specifies whether the claim must be present in the token. Defaults to false . When true , the token must contain the claim.

expectedValues -> (list)

The accepted value for the claim. The value cannot be empty. When a value is specified, the claim must match it exactly, and the match is case-sensitive. When no value is specified, the claim only has to be present.

(string)

jwksUri -> (string)

The JSON Web Key Set (JWKS) URI that API Gateway resolved from the issuer’s OpenID Connect discovery document. This value is read-only and cannot be set.

defaultAlgorithms -> (list)

The signing algorithms configured for the authorizer.

(string)

A JSON Web Signature (JWS) signing algorithm. Valid values are RS256 , RS384 , RS512 , ES256 , ES384 , and ES512 . HMAC (HS256 , HS384 , HS512 ) and none are not valid values.

Possible values:

  • RS256
  • RS384
  • RS512
  • ES256
  • ES384
  • ES512