Authorizer
- Print
- PDF
Authorizer
- Print
- PDF
Article Summary
Share feedback
Thanks for sharing your feedback!
Create an authorizer
URL
POST https://apigateway.apigw.ntruss.com/api/v1/authorizers
Request Parameter
- None
Request Body
{
"cacheTtlSec" : 0,
"authorizerName" : "authorizerName",
"authorizerConfig" : {
"functionId" : "functionId",
"payload" : [ {
"in" : "HEADER",
"name" : "name"
} ],
"region" : "region"
},
"authorizerType" : "CLOUD_FUNCTIONS",
"authorizerDescription" : "authorizerDescription"
}
Response Code
- 201
Response Body
{
"cacheTtlSec" : 0,
"authorizerId" : "authorizerId",
"domainCode" : "domainCode",
"modTime" : "2000-01-23T04:56:07.000+00:00",
"modifier" : "modifier",
"authorizerName" : "authorizerName",
"tenantId" : "tenantId",
"authorizerConfig" : {
"functionId" : "functionId",
"payload" : [ {
"in" : "HEADER",
"name" : "name"
} ],
"region" : "region"
},
"authorizerType" : "authorizerType",
"authorizerDescription" : "authorizerDescription"
}
Delete an authorizer
URL
DELETE https://apigateway.apigw.ntruss.com/api/v1/authorizers/{authorizer-id}
Request Parameter
| Name | Position | Required | Type | Description |
|---|---|---|---|---|
| authorizerId | path | Y | String | Authorizer Id Length(Min/Max): 0/10 |
Request Body
- None
Response Code
- 204
Response Body
- None
Get an authorizer
URL
GET https://apigateway.apigw.ntruss.com/api/v1/authorizers/{authorizer-id}
Request Parameter
| Name | Position | Required | Type | Description |
|---|---|---|---|---|
| authorizerId | path | Y | String | Authorizer Id Length(Min/Max): 0/10 |
Request Body
- None
Response Code
- 200
Response Body
{
"cacheTtlSec" : 0,
"authorizerId" : "authorizerId",
"domainCode" : "domainCode",
"modTime" : "2000-01-23T04:56:07.000+00:00",
"modifier" : "modifier",
"authorizerName" : "authorizerName",
"tenantId" : "tenantId",
"authorizerConfig" : {
"functionId" : "functionId",
"payload" : [ {
"in" : "HEADER",
"name" : "name"
} ],
"region" : "region"
},
"authorizerType" : "authorizerType",
"authorizerDescription" : "authorizerDescription"
}
Search authorizers by authorizerName
URL
GET https://apigateway.apigw.ntruss.com/api/v1/authorizers
Request Parameter
| Name | Position | Required | Type | Description |
|---|---|---|---|---|
| offset | query string | N | Long | Offset Min: 0 Max: 9,223,372,036,854,775,807 |
| limit | query string | N | Long | Limit Min: 1 Max: 9,223,372,036,854,775,807 |
| name | query string | N | String | Name Length(Min/Max): 0/20 |
Request Body
- None
Response Code
- 200
Response Body
{
"initialCount" : 0,
"total" : 6,
"authorizers" : [ {
"authorizerId" : "authorizerId",
"authorizerName" : "authorizerName",
"disabled" : true,
"permission" : "permission",
"authorizerDescription" : "authorizerDescription",
"actionName" : "actionName"
} ]
}
Modify an authorizer
URL
PUT https://apigateway.apigw.ntruss.com/api/v1/authorizers/{authorizer-id}
Request Parameter
| Name | Position | Required | Type | Description |
|---|---|---|---|---|
| authorizerId | path | Y | String | Authorizer Id Length(Min/Max): 0/10 |
Request Body
{
"cacheTtlSec" : 0,
"authorizerName" : "authorizerName",
"authorizerConfig" : {
"functionId" : "functionId",
"payload" : [ {
"in" : "HEADER",
"name" : "name"
} ],
"region" : "region"
},
"authorizerType" : "CLOUD_FUNCTIONS",
"authorizerDescription" : "authorizerDescription"
}
Response Code
- 204
Response Body
- None
Test authorizer
URL
POST https://apigateway.apigw.ntruss.com/api/v1/authorizers/{authorizer-id}/test
Request Parameter
| Name | Position | Required | Type | Description |
|---|---|---|---|---|
| authorizerId | path | Y | String | Authorizer Id Length(Min/Max): 0/10 |
Request Body
{
"params" : "{}"
}
Response Code
- 200
Response Body
{
"response" : {
"latency" : "latency",
"body" : "{}",
"status" : 0
}
}
Was this article helpful?