Help Center/ API Gateway/ API Reference/ Dedicated Gateway APIs (V2)/ Custom Authorizer Management/ Modifying a Custom Authorizer

Updated on 2024-11-11 GMT+08:00

Online Debugging

CLI Examples

View PDF

Modifying a Custom Authorizer

Function

This API is used to modify a custom authorizer.

Calling Method

For details, see Calling APIs.

URI

PUT /v2/{project_id}/apigw/instances/{instance_id}/authorizers/{authorizer_id}

**Table 1** Path Parameters
Parameter	Mandatory	Type	Description
project_id	Yes	String	Project ID. For details about how to obtain it, see Obtaining a Project ID.
instance_id	Yes	String	Gateway ID, which can be obtained from the gateway information on the APIG console.
authorizer_id	Yes	String	Custom authorizer ID.

Request Parameters

**Table 2** Request header parameters
Parameter	Mandatory	Type	Description
X-Auth-Token	Yes	String	User token. It can be obtained by calling the IAM API used to obtain a user token. The value of X-Subject-Token in the response header is a token.

**Table 3** Request body parameters
Parameter	Mandatory	Type	Description
name	Yes	String	Custom authorizer name. It can contain 3 to 64 characters, starting with a letter. Only letters, digits, and underscores (_) are allowed.
type	Yes	String	Custom authorizer type. FRONTEND BACKEND Modification is not allowed.
authorizer_type	Yes	String	Value: FUNC.
authorizer_uri	Yes	String	Function URN.
network_type	No	String	Function network architecture: V1: non-VPC V2: VPC Default: V1
authorizer_version	No	String	Function version. If both a function alias URN and version are passed, the alias URN will be used and the version will be ignored. Maximum: 64
authorizer_alias_uri	No	String	Function alias URN. If both a function alias URN and version are passed, the alias URN will be used and the version will be ignored.
identities	No	Array of Identity objects	Identity source.
ttl	No	Integer	Maximum cache age.
user_data	No	String	User data.
ld_api_id	No	String	Custom backend ID. Currently, this parameter is not supported.
need_body	No	Boolean	Indicates whether to send the body.

**Table 4** Identity
Parameter	Mandatory	Type	Description
name	Yes	String	Parameter name.
location	Yes	String	Parameter location.
validation	No	String	Parameter verification expression. The default value is null, indicating that no verification is performed.

Response Parameters

Status code: 200

**Table 5** Response body parameters
Parameter	Type	Description
name	String	Custom authorizer name. It can contain 3 to 64 characters, starting with a letter. Only letters, digits, and underscores (_) are allowed.
type	String	Custom authorizer type. FRONTEND BACKEND Modification is not allowed.
authorizer_type	String	Value: FUNC.
authorizer_uri	String	Function URN.
network_type	String	Function network architecture: V1: non-VPC V2: VPC Default: V1
authorizer_version	String	Function version. If both a function alias URN and version are passed, the alias URN will be used and the version will be ignored. Maximum: 64
authorizer_alias_uri	String	Function alias URN. If both a function alias URN and version are passed, the alias URN will be used and the version will be ignored.
identities	Array of Identity objects	Identity source.
ttl	Integer	Maximum cache age.
user_data	String	User data.
ld_api_id	String	Custom backend ID. Currently, this parameter is not supported.
need_body	Boolean	Indicates whether to send the body.
id	String	Custom authorizer ID.
create_time	String	Creation time.
roma_app_id	String	ID of the application to which the custom authorizer belongs. Currently, this parameter is not supported.
roma_app_name	String	Name of the application to which the custom authorizer belongs. Currently, this parameter is not supported.

**Table 6** Identity
Parameter	Type	Description
name	String	Parameter name.
location	String	Parameter location.
validation	String	Parameter verification expression. The default value is null, indicating that no verification is performed.

Status code: 401

**Table 7** Response body parameters
Parameter	Type	Description
error_code	String	Error code.
error_msg	String	Error message.

Status code: 403

**Table 8** Response body parameters
Parameter	Type	Description
error_code	String	Error code.
error_msg	String	Error message.

Status code: 404

**Table 9** Response body parameters
Parameter	Type	Description
error_code	String	Error code.
error_msg	String	Error message.

Status code: 500

**Table 10** Response body parameters
Parameter	Type	Description
error_code	String	Error code.
error_msg	String	Error message.

Example Requests

Updating a frontend custom authorizer

{
  "name" : "Authorizer_demo",
  "type" : "FRONTEND",
  "authorizer_type" : "FUNC",
  "authorizer_uri" : "urn:fss:xx-xxx:106506b9a92342df9a5025fc12351cfc:function:defau:apigDemo_1592617458814",
  "network_type" : "V1",
  "authorizer_version" : "v1",
  "authorizer_alias_uri" : "urn:fss:xx-xxx-4:106506b9a92342df9a5025fc12351cfc:function:defau:apigDemo_1592617458814:!v1",
  "user_data" : "authorizer_test",
  "identities" : [ {
    "name" : "header",
    "location" : "HEADER"
  } ]
}

Example Responses

Status code: 200

{
  "name" : "Authorizer_demo",
  "type" : "FRONTEND",
  "authorizer_type" : "FUNC",
  "authorizer_uri" : "urn:fss:xx-xxx-4:106506b9a92342df9a5025fc12351cfc:function:defau:apigDemo_1592617458814",
  "network_type" : "V1",
  "authorizer_version" : "v1",
  "authorizer_alias_uri" : "urn:fss:xx-xxx-4:106506b9a92342df9a5025fc12351cfc:function:defau:apigDemo_1592617458814:!v1",
  "identities" : [ {
    "name" : "header",
    "location" : "HEADER"
  } ],
  "ttl" : 5,
  "user_data" : "authorizer_test",
  "id" : "0d982c1ac3da493dae47627b6439fc5c",
  "create_time" : "2020-07-08T03:27:52.000+0000"
}

Status code: 401

Unauthorized

{
  "error_code" : "APIG.1002",
  "error_msg" : "Incorrect token or token resolution failed"
}

Status code: 403

Forbidden

{
  "error_code" : "APIG.1005",
  "error_msg" : "No permissions to request this method"
}

Status code: 404

Not Found

{
  "error_code" : "APIG.3081",
  "error_msg" : "authorizer with id: 0d982c1ac3da493dae47627b6439fc5c not found"
}

Status code: 500

Internal Server Error

{
  "error_code" : "APIG.9999",
  "error_msg" : "System error"
}

Status Codes

Status Code	Description
200	OK
401	Unauthorized
403	Forbidden
404	Not Found
500	Internal Server Error

Error Codes

See Error Codes.

Parent topic: Custom Authorizer Management

Previous topic: Creating a Custom Authorizer

Next topic: Deleting a Custom Authorizer

Feedback

Was this page helpful?

Helpful Not helpful

Provide feedback

Thank you very much for your feedback. We will continue working to improve the documentation.See the reply and handling status in My Cloud VOC.

The system is busy. Please try again later.

Which of the following issues have you encountered?

Content is inconsistent with the product UI

Unclear descriptions

Lack of examples or code

Incorrect steps

Can't find what I need

Lack of best practices

Feedback (optional)

0/500

Select at least one type of issue, and enter your comments or suggestions.

Enter a maximum of 500 characters.

Submit Cancel

For any further questions, feel free to contact us through the chatbot.

Chatbot