Resetting an Application Secret

Function

This API is used to reset an application secret.

Authorization Information

Each account has all the permissions required to call all APIs, but IAM users must be assigned the required permissions. For details about the required permissions, see Permissions Policies and Supported Actions.

URI

PUT /v2/{project_id}/instances/{instance_id}/apps/{app_id}/secret

**Table 1** Path Parameters
Parameter	Mandatory	Type	Description
app_id	Yes	String	Application ID.
instance_id	Yes	String	Instance ID.
project_id	Yes	String	Project ID. For details about how to obtain the project ID, see "Appendix" > "Obtaining a Project ID" in the API Reference.

Request Parameters

**Table 2** Request header parameters
Parameter	Mandatory	Type	Description
X-Auth-Token	Yes	String	User token, which can be obtained by calling the IAM API (value of X-Subject-Token in the response header).

**Table 3** Request body parameters
Parameter	Mandatory	Type	Description
secret	No	String	Application authentication access secret. If this field does not exist or the value is null, a random value is generated. Characters allowed: letters, digits, and the following special characters: ! @#$%+=.-/ Complexity: a combination of uppercase letters, lowercase letters, digits, and special characters. Complexity check is not required.

Response Parameters

Status code: 200

**Table 4** Response body parameters
Parameter	Type	Description
id	String	Application ID.
secret	String	Application authentication access secret. If this field does not exist or the value is null, a random value is generated. Characters allowed: letters, digits, and the following special characters: ! @#$%+=.-/ Complexity: a combination of uppercase letters, lowercase letters, digits, and special characters. Complexity check is not required.

Status code: 403

**Table 5** Response body parameters
Parameter	Type	Description
error_code	String	Error code.
error_msg	String	Error message.
error_details	String	Error information.
request_id	String	Request ID.

Example Requests

Reset the secret of an integration application to a specified value.

{
  "secret" : "JNs1****Djd"
}

Example Responses

Status code: 200

{
  "id" : "b2e6b145-4f3f-4a80-aa45-f4b8029f95a3",
  "secret" : "JNs****Djd"
}

Status code: 403

Forbidden

{
  "error_code" : "ROMA.00000101",
  "error_msg" : "error summary",
  "error_details" : "some error details here",
  "request_id" : "13760c1fe8655e61209b75665e9bef43"
}