Help Center/ CodeArts Deploy/ API Reference/ APIs/ Managing Application Permissions/ Modifying Application Permissions in Batches
Updated on 2024-08-30 GMT+08:00

Modifying Application Permissions in Batches

Function

This API is used to modify application permissions in batches.

Calling Method

For details, see Calling APIs.

URI

PUT /v3/applications/permissions

Request Parameters

Table 1 Request header parameters

Parameter

Mandatory

Type

Description

X-Auth-Token

Yes

String

User token. It can be obtained by calling an IAM API. The value of X-Subject-Token in the response header is the user token.

Table 2 Request body parameters

Parameter

Mandatory

Type

Description

project_id

Yes

String

Project ID

application_ids

Yes

Array of strings

Application list

roles

Yes

Array of AppPermission objects

Role permissions

Table 3 AppPermission

Parameter

Mandatory

Type

Description

dev_role_id

Yes

String

Role ID

can_modify

Yes

Boolean

Whether you have the edit permission

can_delete

Yes

Boolean

Whether you have the delete permission

can_view

Yes

Boolean

Whether you have the view permission

can_execute

Yes

Boolean

Whether you have the execute permission

can_copy

Yes

Boolean

Whether you have the clone permission

can_manage

Yes

Boolean

Whether you can manage permissions

can_create_env

Yes

Boolean

Whether you have the permission to create environments

can_disable

Yes

Boolean

Whether you have the disable permission

Response Parameters

Status code: 200

Table 4 Response body parameters

Parameter

Type

Description

status

String

Request success or failure status

Example Requests

https://{endpoint}/v3/applications/permissions

{
  "application_ids" : [ "eac65c10c5c34df1824af96ec93a9eea", "3ba2ad194ff141e39b1d3d0749242858" ],
  "project_id" : "0a38ce9ba3c740c199a0f872b6163661",
  "roles" : [ {
    "dev_role_id" : "ba0d4b2e-f7e6-46a3-aece-3002ff640e73",
    "can_copy" : true,
    "can_create_env" : true,
    "can_delete" : true,
    "can_disable" : true,
    "can_execute" : true,
    "can_manage" : true,
    "can_modify" : true,
    "can_view" : true
  } ]
}

Example Responses

Status code: 200

OK: The request is successful.

{
  "status" : "success"
}

SDK Sample Code

The SDK sample code is as follows.

Java

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
package com.huaweicloud.sdk.test;

import com.huaweicloud.sdk.core.auth.ICredential;
import com.huaweicloud.sdk.core.auth.BasicCredentials;
import com.huaweicloud.sdk.core.exception.ConnectionException;
import com.huaweicloud.sdk.core.exception.RequestTimeoutException;
import com.huaweicloud.sdk.core.exception.ServiceResponseException;
import com.huaweicloud.sdk.codeartsdeploy.v2.region.CodeArtsDeployRegion;
import com.huaweicloud.sdk.codeartsdeploy.v2.*;
import com.huaweicloud.sdk.codeartsdeploy.v2.model.*;

import java.util.List;
import java.util.ArrayList;

public class BatchUpdateApplicationPermissionsSolution {

    public static void main(String[] args) {
        // The AK and SK used for authentication are hard-coded or stored in plaintext, which has great security risks. It is recommended that the AK and SK be stored in ciphertext in configuration files or environment variables and decrypted during use to ensure security.
        // In this example, AK and SK are stored in environment variables for authentication. Before running this example, set environment variables CLOUD_SDK_AK and CLOUD_SDK_SK in the local environment
        String ak = System.getenv("CLOUD_SDK_AK");
        String sk = System.getenv("CLOUD_SDK_SK");

        ICredential auth = new BasicCredentials()
                .withAk(ak)
                .withSk(sk);

        CodeArtsDeployClient client = CodeArtsDeployClient.newBuilder()
                .withCredential(auth)
                .withRegion(CodeArtsDeployRegion.valueOf("<YOUR REGION>"))
                .build();
        BatchUpdateApplicationPermissionsRequest request = new BatchUpdateApplicationPermissionsRequest();
        BatchUpdateApplicationPermissionsRequestBody body = new BatchUpdateApplicationPermissionsRequestBody();
        List<AppPermission> listbodyRoles = new ArrayList<>();
        listbodyRoles.add(
            new AppPermission()
                .withDevRoleId("ba0d4b2e-f7e6-46a3-aece-3002ff640e73")
                .withCanModify(true)
                .withCanDelete(true)
                .withCanView(true)
                .withCanExecute(true)
                .withCanCopy(true)
                .withCanManage(true)
                .withCanCreateEnv(true)
                .withCanDisable(true)
        );
        List<String> listbodyApplicationIds = new ArrayList<>();
        listbodyApplicationIds.add("eac65c10c5c34df1824af96ec93a9eea");
        listbodyApplicationIds.add("3ba2ad194ff141e39b1d3d0749242858");
        body.withRoles(listbodyRoles);
        body.withApplicationIds(listbodyApplicationIds);
        body.withProjectId("0a38ce9ba3c740c199a0f872b6163661");
        request.withBody(body);
        try {
            BatchUpdateApplicationPermissionsResponse response = client.batchUpdateApplicationPermissions(request);
            System.out.println(response.toString());
        } catch (ConnectionException e) {
            e.printStackTrace();
        } catch (RequestTimeoutException e) {
            e.printStackTrace();
        } catch (ServiceResponseException e) {
            e.printStackTrace();
            System.out.println(e.getHttpStatusCode());
            System.out.println(e.getRequestId());
            System.out.println(e.getErrorCode());
            System.out.println(e.getErrorMsg());
        }
    }
}

Python

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
# coding: utf-8

import os
from huaweicloudsdkcore.auth.credentials import BasicCredentials
from huaweicloudsdkcodeartsdeploy.v2.region.codeartsdeploy_region import CodeArtsDeployRegion
from huaweicloudsdkcore.exceptions import exceptions
from huaweicloudsdkcodeartsdeploy.v2 import *

if __name__ == "__main__":
    # The AK and SK used for authentication are hard-coded or stored in plaintext, which has great security risks. It is recommended that the AK and SK be stored in ciphertext in configuration files or environment variables and decrypted during use to ensure security.
    # In this example, AK and SK are stored in environment variables for authentication. Before running this example, set environment variables CLOUD_SDK_AK and CLOUD_SDK_SK in the local environment
    ak = os.environ["CLOUD_SDK_AK"]
    sk = os.environ["CLOUD_SDK_SK"]

    credentials = BasicCredentials(ak, sk)

    client = CodeArtsDeployClient.new_builder() \
        .with_credentials(credentials) \
        .with_region(CodeArtsDeployRegion.value_of("<YOUR REGION>")) \
        .build()

    try:
        request = BatchUpdateApplicationPermissionsRequest()
        listRolesbody = [
            AppPermission(
                dev_role_id="ba0d4b2e-f7e6-46a3-aece-3002ff640e73",
                can_modify=True,
                can_delete=True,
                can_view=True,
                can_execute=True,
                can_copy=True,
                can_manage=True,
                can_create_env=True,
                can_disable=True
            )
        ]
        listApplicationIdsbody = [
            "eac65c10c5c34df1824af96ec93a9eea",
            "3ba2ad194ff141e39b1d3d0749242858"
        ]
        request.body = BatchUpdateApplicationPermissionsRequestBody(
            roles=listRolesbody,
            application_ids=listApplicationIdsbody,
            project_id="0a38ce9ba3c740c199a0f872b6163661"
        )
        response = client.batch_update_application_permissions(request)
        print(response)
    except exceptions.ClientRequestException as e:
        print(e.status_code)
        print(e.request_id)
        print(e.error_code)
        print(e.error_msg)

Go

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
package main

import (
	"fmt"
	"github.com/huaweicloud/huaweicloud-sdk-go-v3/core/auth/basic"
    codeartsdeploy "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/codeartsdeploy/v2"
	"github.com/huaweicloud/huaweicloud-sdk-go-v3/services/codeartsdeploy/v2/model"
    region "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/codeartsdeploy/v2/region"
)

func main() {
    // The AK and SK used for authentication are hard-coded or stored in plaintext, which has great security risks. It is recommended that the AK and SK be stored in ciphertext in configuration files or environment variables and decrypted during use to ensure security.
    // In this example, AK and SK are stored in environment variables for authentication. Before running this example, set environment variables CLOUD_SDK_AK and CLOUD_SDK_SK in the local environment
    ak := os.Getenv("CLOUD_SDK_AK")
    sk := os.Getenv("CLOUD_SDK_SK")

    auth := basic.NewCredentialsBuilder().
        WithAk(ak).
        WithSk(sk).
        Build()

    client := codeartsdeploy.NewCodeArtsDeployClient(
        codeartsdeploy.CodeArtsDeployClientBuilder().
            WithRegion(region.ValueOf("<YOUR REGION>")).
            WithCredential(auth).
            Build())

    request := &model.BatchUpdateApplicationPermissionsRequest{}
	var listRolesbody = []model.AppPermission{
        {
            DevRoleId: "ba0d4b2e-f7e6-46a3-aece-3002ff640e73",
            CanModify: true,
            CanDelete: true,
            CanView: true,
            CanExecute: true,
            CanCopy: true,
            CanManage: true,
            CanCreateEnv: true,
            CanDisable: true,
        },
    }
	var listApplicationIdsbody = []string{
        "eac65c10c5c34df1824af96ec93a9eea",
	    "3ba2ad194ff141e39b1d3d0749242858",
    }
	request.Body = &model.BatchUpdateApplicationPermissionsRequestBody{
		Roles: listRolesbody,
		ApplicationIds: listApplicationIdsbody,
		ProjectId: "0a38ce9ba3c740c199a0f872b6163661",
	}
	response, err := client.BatchUpdateApplicationPermissions(request)
	if err == nil {
        fmt.Printf("%+v\n", response)
    } else {
        fmt.Println(err)
    }
}

More

For SDK sample code of more programming languages, see the Sample Code tab in API Explorer. SDK sample code can be automatically generated.

Status Codes

Status Code

Description

200

OK: The request is successful.

Error Codes

See Error Codes.