Skip to main content

Software-Based System Workflow Usage

System workflow encapsulates commonly used OpenAPIs for approval flows, helping users avoid API calls during approval page rendering.

Creation Process​

  1. If the server supports public network access, you can enter the SecretId and SecretKey of the Tencent Cloud root account.

    tip

    SecretId and SecretKey must be viewed using the root account.

  2. On the local development platform, select the APIs connector to create a system workflow.

  3. Fill in the relevant information for the system workflow

  4. System Workflow API Method Showcase

Notes​

If the local server cannot access the public network, log in to the server and view the SecretId and SecretKey in the operation logs.

Standalone Edition: Follow the steps below to obtain

Log in to the server and execute the following curl command, replacing Uin, SubAccountUin, and EnvId (the three values corresponding to the current software-based license application).

docker exec -it idaasserver bash

# Execute this curl command to replace the values of the Uin, SubAccountUin, and EnvId fields
curl -X POST --location "http://127.0.0.1:9080/cloudbase.auth.v1.Mgr/AddClient" -H "Content-Type: application/json" \
-d "{
      \"AppId\": 1,
      \"Uin\": \"100008215038\",
      \"SubAccountUin\": \"100008215038\",
      \"Region\": \"ap-shanghai\",
      \"RequestId\": \"uuid-123\",
      \"ClientIp\": \"192.168.1.1\",
      \"EnvId\": \"lowcode-4g87m66we5207666\",
      \"Type\": \"SERVER\",
      \"Platform\": \"SERVICE\",
      \"Name\": {
        \"Message\": \"server\"
      },
      \"AllowedScopes\": [\"all\"]
    }"

# Response Example
{"Response":{"Id":"AN8b0QABOXXXXXXXXX","Secret":"RSvk6aMjEe-XXXXXXXX","UserId":"1.100008215038.100008215038","Name":{"Message":"server","Localized":[]},"Description":null,"Picture":"","ShowAuthorizePage":"UNKNOWN","Type":"SERVER","Level":0,"MaxDevice":0,"AllowedScopes":["all"],"Domains":[],"IpWhitelist":[],"Tags":[],"Status":"DEFAULT","Url":"","RefreshTokenExpiresIn":0,"AccessTokenExpiresIn":0,"OrganizationId":"","Meta":{},"CreatedAt":"2024-11-15T15:28:55+08:00","UpdatedAt":"2024-11-15T15:28:55+08:00","Platform":"SERVICE","UserType":"USERTYPE_DEFAULT","Secrets":[],"RedirectUri":[],"UserGroupType":"SYSTEM","ServerName":"","Providers":[],"RequestId":"uuid-123"}}


To obtain a k8s cluster, follow the steps below

  1. To get the pod name of idaasserver, run the command: kubectl -n <your-namespace> get pod | grep idaasserver
  2. If multiple pods exist, access the idaasserver in any one of them and run the command: kubectl -n software exec -it <pod name queried in Step 1> -c idaasserver -- bash
  3. Execute the following curl command, replacing Uin, SubAccountUin, and EnvId (the three values corresponding to the current software-based license application).
# Execute this curl command to replace the values of the Uin, SubAccountUin, and EnvId fields
curl -X POST --location "http://127.0.0.1:9080/cloudbase.auth.v1.Mgr/AddClient" -H "Content-Type: application/json" \
-d "{
      \"AppId\": 1,
      \"Uin\": \"100008215038\",
      \"SubAccountUin\": \"100008215038\",
      \"Region\": \"ap-shanghai\",
      \"RequestId\": \"uuid-123\",
      \"ClientIp\": \"192.168.1.1\",
      \"EnvId\": \"lowcode-4g87m66we5207666\",
      \"Type\": \"SERVER\",
      \"Platform\": \"SERVICE\",
      \"Name\": {
        \"Message\": \"server\"
      },
      \"AllowedScopes\": [\"all\"]
    }"

info

The Id in the returned result corresponds to SecretId, and Secret corresponds to SecretKey. Simply modify and save the basic information of the system workflow.