AWS IoT
开发人员指南
AWS 文档中描述的 AWS 服务或功能可能因区域而异。要查看适用于中国区域的差异,请参阅 Amazon AWS 入门

TestInvokeAuthorizer

TestInvokeAuthorizer

调用指定的自定义授权方以用于测试目的。

https

请求语法:

POST /authorizer/authorizerName/test Content-type: application/json { "token": "string", "tokenSignature": "string" }

URI 请求参数:

名称

类型

请求?

描述

authorizerName

AuthorizerName

自定义授权方名称。

请求正文参数:

名称

类型

请求?

描述

token

Token

您的自定义身份验证服务返回的令牌。

tokenSignature

TokenSignature

由令牌以及您的自定义身份验证服务的私有密钥构成的签名。

响应语法:

Content-type: application/json { "isAuthenticated": "boolean", "principalId": "string", "policyDocuments": [ "string" ], "refreshAfterInSeconds": "integer", "disconnectAfterInSeconds": "integer" }

响应正文参数:

名称

类型

请求?

描述

isAuthenticated

IsAuthenticated

如果令牌已通过身份验证,则为 True;否则为 False。

principalId

委托人 ID

委托人 ID。

policyDocuments

PolicyDocuments

IAM 策略文档。

refreshAfterInSeconds

Seconds

秒数,在此之后刷新临时凭证。

disconnectAfterInSeconds

Seconds

秒数,在此之后终止连接。

错误:

ResourceNotFoundException

指定的资源不存在。

HTTP 响应代码:404

InvalidRequestException

请求的内容无效。例如,UpdateJobExecution 请求包含无效状态详细信息时,将返回此代码。消息包含有关错误的详细信息。

HTTP 响应代码:400

ThrottlingException

速率超过限制。

HTTP 响应代码:429

UnauthorizedException

您没有权限执行此操作。

HTTP 响应代码:401

ServiceUnavailableException

服务暂时不可用。

HTTP 响应代码:503

InternalFailureException

出现意外错误。

HTTP 响应代码:500

InvalidResponseException

响应无效。

HTTP 响应代码:400

cli

摘要:

aws iot test-invoke-authorizer \ --authorizer-name <value> \ --token <value> \ --token-signature <value> \ [--cli-input-json <value>] \ [--generate-cli-skeleton]

cli-input-json format:

{ "authorizerName": "string", "token": "string", "tokenSignature": "string" }

cli-input-json 字段:

名称

类型

描述

authorizerName

字符串

最大长度:128,最小长度:1

模式:[w=,@-]+

自定义授权方名称。

token

字符串

最大长度:1024,最小长度:1

您的自定义身份验证服务返回的令牌。

tokenSignature

字符串

最大长度:2560,最小长度:1

模式:[A-Za-z0-9+/]+={0,2}

由令牌以及您的自定义身份验证服务的私有密钥构成的签名。

输出:

{ "isAuthenticated": "boolean", "principalId": "string", "policyDocuments": [ "string" ], "refreshAfterInSeconds": "integer", "disconnectAfterInSeconds": "integer" }

cli 输出字段:

名称

类型

描述

isAuthenticated

布尔值

如果令牌已通过身份验证,则为 True;否则为 False。

principalId

字符串

最大长度:128,最小长度:1

模式:[a-zA-Z0-9]+

委托人 ID。

policyDocuments

列表

成员:PolicyDocument

IAM 策略文档。

refreshAfterInSeconds

integer

秒数,在此之后刷新临时凭证。

disconnectAfterInSeconds

integer

秒数,在此之后终止连接。

错误:

ResourceNotFoundException

指定的资源不存在。

InvalidRequestException

请求的内容无效。例如,UpdateJobExecution 请求包含无效状态详细信息时,将返回此代码。消息包含有关错误的详细信息。

ThrottlingException

速率超过限制。

UnauthorizedException

您没有权限执行此操作。

ServiceUnavailableException

服务暂时不可用。

InternalFailureException

出现意外错误。

InvalidResponseException

响应无效。