TestInvokeAuthorizerResponse

Represents the response of the test invoke request for a custom Authorizer

APIs.ioEngineeringPlatform

Properties

Name Type Description
clientStatus object
log object
latency object
principalId object
policy object
authorization object
claims object
View JSON Schema on GitHub

JSON Schema

apis-io-engineering-platform-testinvokeauthorizerresponse-schema.json Raw ↑
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/TestInvokeAuthorizerResponse",
  "title": "TestInvokeAuthorizerResponse",
  "type": "object",
  "properties": {
    "clientStatus": {
      "allOf": [
        {
          "$ref": "#/components/schemas/Integer"
        },
        {
          "description": "The HTTP status code that the client would have received. Value is 0 if the authorizer succeeded."
        }
      ]
    },
    "log": {
      "allOf": [
        {
          "$ref": "#/components/schemas/String"
        },
        {
          "description": "The API Gateway execution log for the test authorizer request."
        }
      ]
    },
    "latency": {
      "allOf": [
        {
          "$ref": "#/components/schemas/Long"
        },
        {
          "description": "The execution latency of the test authorizer request."
        }
      ]
    },
    "principalId": {
      "allOf": [
        {
          "$ref": "#/components/schemas/String"
        },
        {
          "description": "The principal identity returned by the Authorizer"
        }
      ]
    },
    "policy": {
      "allOf": [
        {
          "$ref": "#/components/schemas/String"
        },
        {
          "description": "The JSON policy document returned by the Authorizer"
        }
      ]
    },
    "authorization": {
      "allOf": [
        {
          "$ref": "#/components/schemas/MapOfStringToList"
        },
        {
          "description": "The authorization response."
        }
      ]
    },
    "claims": {
      "allOf": [
        {
          "$ref": "#/components/schemas/MapOfStringToString"
        },
        {
          "description": "The open identity claims, with any supported custom attributes, returned from the Cognito Your User Pool configured for the API."
        }
      ]
    }
  },
  "description": "Represents the response of the test invoke request for a custom Authorizer"
}