Obtaining User Permissions
Function
This API is used to obtain user permissions.
Calling Method
For details, see Calling APIs.
URI
GET /v1/domain/user-permission
|
Parameter |
Mandatory |
Type |
Description |
|---|---|---|---|
|
project_id |
Yes |
String |
Definition CodeArts project ID. For details, seeObtaining a CodeArts Project ID. Constraints N/A. Range Use a 32-character string that includes digits and lowercase letters. Default Value N/A. |
Request Parameters
|
Parameter |
Mandatory |
Type |
Description |
|---|---|---|---|
|
X-Auth-Token |
Yes |
String |
Definition User token. (The value of the X-Subject-Token response header is the user token.) It can be obtained by calling the IAM service API. For details, seeObtaining an IAM User Token. Constraints Global tenant tokens are not supported. Use a region-level token whose scope is project. Range N/A. Default Value N/A. |
Response Parameters
Status code: 200
|
Parameter |
Type |
Description |
|---|---|---|
|
result |
result object |
Definition Data returned after the API is successfully called. Range N/A. |
|
error |
String |
Definition Returned error message. Range N/A. |
|
status |
String |
Definition Returned status information. Range ● success: The API call is successful. ● fail: The API call failed. |
|
Parameter |
Type |
Description |
|---|---|---|
|
project_id |
String |
Definition CodeArts project ID. ID of the project to which the build task belongs. Range N/A. |
|
create_permission |
Boolean |
Definition Whether the user has the create permission. Range ● true: The user has the create permission. ● false: The user does not have the create permission. |
|
modify_permission |
Boolean |
Definition Whether the user has the edit permission. Range ● true: The user has the edit permission. ● false: The user does not have the edit permission. |
|
group_permission |
Boolean |
Definition Whether the user has the group permission. Range ● true: The user has the group permission. ● false: The user does not have the group permission. |
|
delete_permission |
Boolean |
Definition Whether the user has the delete permission. Range ● true: The user has the delete permission. ● false: The user does not have the delete permission. |
|
view_permission |
Boolean |
Definition Whether the user has the view permission. Range ● true: The user has the view permission. ● false: The user does not have the view permission. |
|
execute_permission |
Boolean |
Definition Whether the user has the execute permission. Range ● true: The user has the execute permission. ● false: The user does not have the execute permission. |
|
copy_permission |
Boolean |
Definition Whether the user has the clone permission. Range ● true: The user has the clone permission. ● false: The user does not have the clone permission. |
|
forbidden_permission |
Boolean |
Definition Whether the user has the disable permission. Range ● true: The user has the disable permission. ● false: The user does not have the disable permission. |
|
manager_permission |
Boolean |
Definition Whether the user has the manage permission. Range ● true: The user has the manage permission. ● false: The user does not have the manage permission. |
|
role_id |
String |
Definition Role ID. Range N/A. |
|
role_name |
String |
Definition Role name. Range N/A. |
|
role_ids |
Array of strings |
Definition A collection of role codes. Range N/A. |
|
role_names |
Array of strings |
Definition A collection of role names. Range N/A. |
Example Requests
GET https://{endpoint}/v1/domain/user-permission?project_id=6ecbc5bac7c8442fb3d2563d53c13582
Example Responses
Status code: 200
OK
{
"result" : {
"project_id" : "6ecbc5bac7c8442fb3d2563d53c13582",
"create_permission" : true,
"modify_permission" : true,
"group_permission" : true,
"delete_permission" : true,
"view_permission" : true,
"execute_permission" : true,
"copy_permission" : true,
"forbidden_permission" : true,
"manager_permission" : true,
"role_id" : 4,
"role_name" : "te_admin",
"role_ids" : [ 4 ],
"role_names" : [ "te_admin" ]
},
"error" : null,
"status" : "success"
}
SDK Sample Code
The SDK sample code is as follows.
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 |
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.codeartsbuild.v3.region.CodeArtsBuildRegion; import com.huaweicloud.sdk.codeartsbuild.v3.*; import com.huaweicloud.sdk.codeartsbuild.v3.model.*; public class ShowProjectPermissionSolution { 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); CodeArtsBuildClient client = CodeArtsBuildClient.newBuilder() .withCredential(auth) .withRegion(CodeArtsBuildRegion.valueOf("<YOUR REGION>")) .build(); ShowProjectPermissionRequest request = new ShowProjectPermissionRequest(); try { ShowProjectPermissionResponse response = client.showProjectPermission(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()); } } } |
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 |
# coding: utf-8 import os from huaweicloudsdkcore.auth.credentials import BasicCredentials from huaweicloudsdkcodeartsbuild.v3.region.codeartsbuild_region import CodeArtsBuildRegion from huaweicloudsdkcore.exceptions import exceptions from huaweicloudsdkcodeartsbuild.v3 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 = CodeArtsBuildClient.new_builder() \ .with_credentials(credentials) \ .with_region(CodeArtsBuildRegion.value_of("<YOUR REGION>")) \ .build() try: request = ShowProjectPermissionRequest() response = client.show_project_permission(request) print(response) except exceptions.ClientRequestException as e: print(e.status_code) print(e.request_id) print(e.error_code) print(e.error_msg) |
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 |
package main import ( "fmt" "github.com/huaweicloud/huaweicloud-sdk-go-v3/core/auth/basic" codeartsbuild "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/codeartsbuild/v3" "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/codeartsbuild/v3/model" region "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/codeartsbuild/v3/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 := codeartsbuild.NewCodeArtsBuildClient( codeartsbuild.CodeArtsBuildClientBuilder(). WithRegion(region.ValueOf("<YOUR REGION>")). WithCredential(auth). Build()) request := &model.ShowProjectPermissionRequest{} response, err := client.ShowProjectPermission(request) if err == nil { fmt.Printf("%+v\n", response) } else { fmt.Println(err) } } |
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 |
Error Codes
See Error Codes.
Feedback
Was this page helpful?
Provide feedbackThank you very much for your feedback. We will continue working to improve the documentation.See the reply and handling status in My Cloud VOC.
For any further questions, feel free to contact us through the chatbot.
Chatbot