Update a Custom Authenticator with a Specified ID

project_id

Yes

String

Parameter description: project ID. For details about how to obtain the project ID, see Obtaining a Project ID.

authorizer_id

Yes

String

Custom authenticator ID.

X-Auth-Token

No

String

Parameter description: user token. Obtain the token by calling the IAM API for obtaining a user token through password authentication. In the returned response header, X-Subject-Token is the desired user token. For details about how to obtain the token, see Token Authentication.

Instance-Id

No

String

Parameter description: instance ID. Unique identifier of each instance in the physical multi-tenant scenario. Mandatory for professional editions and recommended in other cases. Log in to the IoTDA console and choose Overview in the navigation pane to view the instance ID. For details, see Viewing Instance Details.

authorizer_name

No

String

Parameter description: name of a custom authenticator, which must be unique under a tenant. Value: The value can contain a maximum of 128 characters. Only letters, digits, underscores (_), and hyphens (-) are allowed.

func_urn

No

String

Parameter description: function uniform resource name (URN), which uniquely identifies the function. It is the address of the processing function corresponding to the custom authenticator.

signing_enable

No

Boolean

Parameter description: whether to enable signature authentication (enabled by default). You are advised to enable this function. If this function is enabled, authentication information that does not meet signature requirements will be rejected to reduce invalid function calls, and signing_token and signing_public_key are mandatory.

signing_token

No

String

Parameter description: key value for signature authentication. Value: The value can contain a maximum of 128 characters. Only letters, digits, underscores (_), and hyphens (-) are allowed.

signing_public_key

No

String

Parameter description: public secret for signature authentication. Used to check whether the signature information carried by the device is correct.

default_authorizer

No

Boolean

Parameter description: whether the current custom authenticator is the default one. The default value is false. If this parameter is set totrue, the current authenticator policy is used for authentication on all devices that support SNI unless otherwise specified.

status

No

String

Parameter description: whether to enable the authentication mode (enabled by default).

• ACTIVE: The authentication is enabled.

• INACTIVE: The authentication is disabled.

cache_enable

No

Boolean

Parameter description: whether to enable the cache function. The default value is false. If this parameter is set to true and the device input parameters (username, client ID, password, certificate information, and function URN) remain unchanged, the cache result is directly used when the cache result exists. You are advised to set this parameter to false during debugging, set this parameter to true during production to avoid frequent function invoking.

authorizer_id

String

Parameter description: custom authenticator ID.

authorizer_name

String

Parameter description: name of a custom authenticator, which must be unique under a tenant. Value: The value can contain a maximum of 128 characters. Only letters, digits, underscores (_), and hyphens (-) are allowed.

func_name

String

Parameter description: function name.

Minimum: 0

Maximum: 65535

func_urn

String

Parameter description: function uniform resource name (URN), which uniquely identifies the function. It is the address of the processing function corresponding to the custom authenticator.

Minimum: 0

Maximum: 65535

signing_enable

Boolean

Parameter description: whether to enable signature authentication (enabled by default). You are advised to enable this function. If this function is enabled, authentication information that does not meet signature requirements will be rejected to reduce invalid function calls.

Default: true

signing_token

String

Parameter description: key value for signature authentication. Value: The value can contain a maximum of 128 characters. Only letters, digits, underscores (_), and hyphens (-) are allowed.

signing_public_key

String

Parameter description: public secret for signature authentication. Used to check whether the signature information carried by the device is correct.

Minimum: 0

Maximum: 65535

default_authorizer

Boolean

Parameter description: whether the authentication mode is used by default. The default value is false.

Default: false

status

String

Parameter description: whether to enable the authentication mode.

• ACTIVE: The authentication is enabled.

• INACTIVE: The authentication is disabled.

Default: INACTIVE

cache_enable

Boolean

Parameter description: whether to enable the cache function. The default value is false. If this parameter is set to true and the device input parameters (username, client ID, password, certificate information, and function URN) remain unchanged, the cache result is directly used when the cache result exists. You are advised to set this parameter to false during debugging, set this parameter to true during production to avoid frequent function invoking.

Default: false

create_time

String

Time when operations on custom authenticator are performed on the IoT platform. The value is in the format of yyyyMMdd'T'HHmmss'Z', for example, 20151212T121212Z.

update_time

String

Time when the custom authenticator is updated on the IoT platform. The value is in the format of yyyyMMdd'T'HHmmss'Z', for example, 20151212T121212Z.

200

OK

400

Bad Request

403

Forbidden

404

Not Found

500

Internal Server Error