Amazon API Gateway REST API Reference

authorizer:update

Changes information about an authorizer.

HTTP Request

PATCH /restapis/<restapi_id>/authorizers/<authorizer_id>

Request Body

{
  "patchOperations" : [ {
    "op" : "String",
    "path" : "String",
    "value" : "String",
    "from" : "String"
  } ]
}

Request Body Fields

The request accepts the following fields in JSON format.

  • patchOperations
  • A list of update operations to be applied to the specified resource and in the order specified in this list.

    • op
    • An update operation to be performed with this PATCH request. The valid value can be "add", "remove", or "replace". Not all valid operations are supported for a given resource. Support of the operations depends on specific operational contexts. Attempts to apply an unsupported operation on a resource will return an error message.

    • path
    • The op operation's target, as identified by a JSON Pointer value that references a location within the targeted resource. For example, if the target resource has an updateable property of {"name":"value"}, the path for this property is /name. If the name property value is a JSON object (e.g., {"name": {"child/name": "child-value"}}), the path for the child/name property will be /name/child~1name. Any slash ("/") character appearing in path names must be escaped with "~1", as shown in the example above. Each op operation can have only one path associated with it.

    • value
    • The new target value of the update operation. When using AWS CLI to update a property of a JSON value, enclose the JSON object with a pair of single quotes in a Linux shell, e.g., '{"a": ...}'. In a Windows shell, see Using JSON for Parameters.

    • from
    • Not supported.

Response

Authorizer

Remarks

The following table shows the supported and unsupported op operations for updateable Authorizer properties of the specified path values.

Updateable property path op = add op = replace op = remove
/authorizerUri Not supported Supported Not supported
/authorizerCredentials Not supported Supported Not supported
/authorizerResultTtlInSeconds Not supported Supported Not supported
/authType Not supported Supported Not supported
/identitySource Not supported Supported Not supported
/identityValidationExpression Not supported Supported Not supported
/name Not supported Supported Not supported
/providerARNs Supported Not supported Supported
/type Not supported Supported Not supported

Example: Update a custom authorizer

Request

The following request updates the identitySource property of a custom authorizer to use a different header to pass the token used by the specified custom authorizer.

PATCH /restapis/mxsmn867vb/authorizers/4unj71 HTTP/1.1
Content-Type: application/json
Host: apigateway.us-east-1.amazonaws.com
X-Amz-Date: 20170223T233106Z
Authorization: AWS4-HMAC-SHA256 Credential={access_key_ID}/20170223/us-east-1/apigateway/aws4_request, SignedHeaders=content-length;content-type;host;x-amz-date, Signature={sig4_hash}

{
  "patchOperations" : [ {
    "op" : "replace",
    "path" : "/identitySource",
    "value" : "method.request.header.ApiAuth"
  }]
}
Response

The successful response returns a 200 OK status code and a payload similar to the following:

{
  "_links": {
    "curies": {
      "href": "http://docs.aws.amazon.com/apigateway/latest/developerguide/restapi-authorizer-{rel}.html&quot;,
      "name": "authorizer",
      "templated": true
    },
    "self": {
      "href": "/restapis/mxsmn867vb/authorizers/4unj71"
    },
    "authorizer:delete": {
      "href": "/restapis/mxsmn867vb/authorizers/4unj71"
    },
    "authorizer:update": {
      "href": "/restapis/mxsmn867vb/authorizers/4unj71"
    }
  },
  "authType": "custom",
  "authorizerCredentials": "arn:aws:iam::123456789012:role/apigAwsProxyRole",
  "authorizerResultTtlInSeconds": 300,
  "authorizerUri": "arn:aws:apigateway:us-east-1:lambda:path/2015-03-31/functions/arn:aws:lambda:us-east-1:123456789012:function:myApiAuthroizer/invocations",
  "id": "4unj71",
  "identitySource": "method.request.header.ApiAuth",
  "name": "my-other-cust-auth",
  "type": "TOKEN"
}

The response returns the updated custom authorizer.

See Also

AWS CLI