Update Application Information


Update the information of an application.

Request Format


POST https://{apigw-address}/app-portal-service/v2.3/app/modify

Request Parameter (Header)


Name Mandatory/Optional Data Type Description
appId Mandatory String Application ID.
tags Mandatory List

Application Tags.

  • If the value is null, application tags will not be updated.
  • If the value is not specified, all application tags will be deleted.
key Optional String The key of a tag, up to 50 characters. The parameter is mandatory unless the “tags” parameter value is null or not specified. You can add up to 5 tag keys to an application, and the keys should be unique.
value Optional String The value of a tag, up to 256 characters. The parameter is mandatory unless the “tags” parameter value is null or not specified.

Request Parameter (URI)


Name Mandatory/Optional Data Type Description
orgId Mandatory String OU ID.

Response Parameter


Name Data Type Description
success Boolean The results for updating application information. true for success, and false for failure.

Error Codes


Error Code Description
31400
  • The required parameters are missing.
  • The length of tag key or value is not valid.
  • The tag keys are more than 5.
  • The tag keys are duplicated.
31404
  • The application does not exist.
  • The OU does not acquire this application.

Samples

Request Sample


url: /app-portal-service/v2.3/app/modify?orgId=your_org_id

method: POST

requestBody:
{
  "appId": "your_app_id",
  "tags": [
      {
        "key": "your_tag_key",
        "value": "your_tag_value"
      },
      {
        "key": "your_tag_key_2",
        "value": "your_tag_value_2"
      }
    ]
}

Return Sample


{
  "code": 0,
  "message": "OK",
  "data": {
    "success":true
  }
}