Authorizerの照会
- 印刷する
- PDF
Authorizerの照会
- 印刷する
- PDF
記事の要約
この要約は役に立ちましたか?
ご意見ありがとうございます
Classic/VPC環境で利用できます。
Authorizerの情報を照会します。
リクエスト
リクエスト形式を説明します。リクエスト形式は次の通りです。
メソッド | URI |
---|---|
GET | /authorizers/{authorizer-id} |
リクエストヘッダ
API Gatewayで共通して使用されるヘッダの詳細は、API Gatewayのリクエストヘッダをご参照ください。
リクエストパスパラメータ
パラメータの説明は次の通りです。
フィールド | タイプ | 必須の有無 | 説明 |
---|---|---|---|
authorizer-id | String | Required | 照会対象の Authorizer ID |
リクエスト例
リクエストのサンプルコードは次の通りです。
curl -X GET 'https://apigateway.apigw.ntruss.com/api/v1/authorizers/{authorizer-id}' \
--header 'Content-Type: application/json' \
--header 'x-ncp-apigw-timestamp: {Timestamp}' \
--header 'x-ncp-iam-access-key: {Access Key}' \
--header 'x-ncp-apigw-signature-v2: {API Gateway Signature}'
レスポンス
レスポンス形式を説明します。
レスポンス構文
構文は次の通りです。
{
"authorizerId": "authorizerId",
"tenantId": "tenantId",
"authorizerName": "authorizerName",
"authorizerDescription": "authorizerDescription",
"authorizerType": "authorizerType",
"authorizerConfig": {
"region": "region",
"functionId": "functionId",
"payload": [
{
"in": "in",
"name": "name"
}
]
},
"modifier": "modifier",
"domainCode": "domainCode",
"modTime": "2024-05-02T08:23:41Z"
}
レスポンスステータスコード
API Gatewayで共通して使用されるレスポンスステータスコードの詳細は、API Gatewayのレスポンスステータスコードをご参照ください。
レスポンス例
レスポンスのサンプルコードは次の通りです。
{
"authorizerId": "*********",
"tenantId": "***4402f55ae4436913a6e2c65bab***",
"authorizerName": "authorizer-***",
"authorizerDescription": "authorizerDescription",
"authorizerType": "CLOUD_FUNCTIONS",
"authorizerConfig": {
"region": "KR",
"functionId": "*****/mypackage/myaction",
"payload": [
{
"in": "HEADER",
"name": "payload-***"
}
]
},
"modifier": "d12c9fd0-****-****-****-246e96591a38",
"domainCode": "PUB",
"modTime": "2024-05-02T08:23:41Z"
}
この記事は役に立ちましたか?