Query the Device Authentication Template List

Function

This API is used by an application to query the device authentication template list on IoT platform.

Debugging

You can debug this API through automatic authentication in API Explorer or use the SDK sample code generated by API Explorer.

Authorization Information

Each account has all the permissions required to call all APIs, but IAM users must be assigned the required permissions.

If you are using role/policy-based authorization, see Permissions Policies and Supported Actions for details on the required permissions.

If you are using identity policy-based authorization, the following identity policy-based permissions are required.

Action	Access Level	Resource Type (*: required)	Condition Key	Alias	Dependencies
iotda:deviceauthenticationtemplate:queryList	List	instance *	g:EnterpriseProjectId	-	-

URI

GET /v5/iot/{project_id}/device-authentication-templates

**Table 1** Path Parameters
Parameter	Mandatory	Type	Description
project_id	Yes	String	Parameter description: project ID. For details, see Obtaining a Project ID.

**Table 2** Query Parameters
Parameter	Mandatory	Type	Description
template_name	No	String	Parameter description: name of an authentication template. Value: The value can contain a maximum of 128 characters. Only letters, digits, underscores (_), and hyphens (-) are allowed.
limit	No	Integer	Parameter description: number of records to display on each page. Value: The value is an integer ranging from 1 to 50. The default value is 10.
marker	No	String	Parameter description: ID of the last record in the previous query. The value is returned by the platform during the previous query. Records are queried in descending order of record IDs (the marker value). A newer record will have a larger ID. If marker is specified, only the records whose IDs are smaller than marker are queried. If marker is not specified, the query starts from the record with the largest ID, that is, the latest record. If all data needs to be queried in sequence, this parameter must be filled with the value of marker returned in the last query response each time. Value: The value must contain 24 hexadecimal characters. The default value is ffffffffffffffffffffffff.
offset	No	Integer	Parameter description: If offset is set to N, the query starts from the N+1 record after the last record in the previous query. The value is an integer ranging from 0 to 500. The default value is 0. If offset is set to 0, the output starts from the first record after the last record in the previous query. To ensure API performance, you can use this parameter together with marker to turn pages. For example, if there are 50 records on each page, you can directly specify offset to jump to the specified page within page 1 and 11. If you want to view records displayed on pages 12 to 22, you need to use the marker value returned on page 11 as the marker value for the next query. Value: The value is an integer ranging from 0 to 500. The default value is 0.

Request Parameters

**Table 3** Request header parameters
Parameter	Mandatory	Type	Description
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. This parameter is required only when the API is called from the management plane in the physical multi-tenant scenario. Log in to the IoTDA console and choose Overview in the navigation pane to check the instance ID.

Response Parameters

Status code: 200

**Table 4** Response body parameters
Parameter	Type	Description
templates	Array of AuthenticationTemplateSimple objects	Parameter description: authentication template details list.
page	Page object	Pagination information of the query results.

**Table 5** AuthenticationTemplateSimple
Parameter	Type	Description
template_id	String	Authentication template ID.
template_name	String	Authentication template name.
create_time	String	Time when an authentication template is created. The value is in the format of yyyyMMdd'T'HHmmss'Z', for example, 20151212T121212Z.
update_time	String	Time when the authentication template was last modified. The value is in the format of yyyyMMdd'T'HHmmss'Z', for example, 20151212T121212Z.
description	String	Description of an authentication template.
status	String	Parameter description: authentication template status. ACTIVE: The authentication template is enabled. INACTIVE: The authentication template is disabled.

**Table 6** Page
Parameter	Type	Description
count	Long	Total number of records that meet the filter criteria.
marker	String	ID of the last record in this query, which can be used in the next query.

Example Requests

Queries the authentication template list of a tenant.

GET https://{endpoint}/v5/iot/{project_id}/device-authentication-templates?template_name={template_name}

Example Responses

Status code: 200

{
  "templates" : [ {
    "template_id" : "5c90fa7d3c4e4405e8525079",
    "template_name" : "myTemplate",
    "description" : "myTemplate",
    "status" : "ACTIVE",
    "create_time" : "20231031T070547Z",
    "update_time" : "20231031T070547Z"
  } ],
  "page" : {
    "count" : 10,
    "marker" : "5c90fa7d3c4e4405e8525079"
  }
}