Help Center/ IoT Device Access/ API Reference/ API Reference on the Application Side/ API/ Access Credential Management/ Generate an Access Credential
Updated on 2024-06-27 GMT+08:00
View PDF

Generate an Access Credential

Function

This API is used by a client to generate an access credential, so the client can use the credential to connect to the platform through a protocol such as AMQP. Only one record is retained. If the API is called again, the access credential is reset and the previous one becomes invalid.

Debugging

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

URI

POST /v5/iot/{project_id}/auth/accesscode

Table 1 Path Parameters

Parameter

Mandatory

Type

Description

project_id

Yes

String

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

Request Parameters

Table 2 Request header parameters

Parameter

Mandatory

Type

Description

X-Auth-Token

No

String

Parameter description: user token. Call the IAM API Obtaining a User Token Through Password Authentication. For details, 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.

Minimum: 0

Maximum: 36
Table 3 Request body parameters

Parameter

Mandatory

Type

Description

type

No

String

Parameter description: access credential type. The default value is AMQP. Options:

  • AMQP

Minimum: 0

Maximum: 16

force_disconnect

No

Boolean

Parameter description: whether to disconnect the AMQP/MQTT connection.

Default: false

Response Parameters

Status code: 201

Table 4 Response body parameters

Parameter

Type

Description

access_key

String

Access credential name, which consists of 8 random characters.

Minimum: 0

Maximum: 8

access_code

String

Access credential.

Minimum: 0

Maximum: 1024

Example Requests

Generates an AMQP access credential.

POST https://{endpoint}/v5/iot/{project_id}/auth/accesscode

{
  "type" : "AMQP"
}

Example Responses

Status code: 201

Created

{
  "access_key" : "examples",
  "access_code" : "examples"
}

Status Codes

Status Code

Description

201

Created

400

Bad Request

401

Unauthorized

403

FORBIDDEN

500

Internal Server Error

Error Codes

See Error Codes.