Updated on 2026-09-30 GMT+08:00

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.

Calling Method

For details, see Calling APIs.

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:accesscode:create

Write

-

g:EnterpriseProjectId

-

-

Action	Access Level	Resource Type (*: required)	Condition Key	Alias	Dependencies
iotda:accesscode:create	Write	-	g:EnterpriseProjectId	-	-

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
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.

**Table 3** Request body parameters
Parameter	Mandatory	Type	Description
type	No	String	Parameter description: access credential type. The default value is AMQP. Options: AMQP
force_disconnect	No	Boolean	Parameter description: whether to disconnect the AMQP/MQTT connection.

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.
access_code	String	Access credential.

Example Requests

Generates an AMQP access credential.

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

{
  "type" : "AMQP"
}

Example Responses

Status code: 201

{
  "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.

Parent topic: Access Credential Management