|
| 1 | +# azure_devops_sdk.api.AccessControlEntriesApi |
| 2 | + |
| 3 | +## Load the API package |
| 4 | +```dart |
| 5 | +import 'package:azure_devops_sdk/api.dart'; |
| 6 | +``` |
| 7 | + |
| 8 | +All URIs are relative to *https://app.vssps.visualstudio.com* |
| 9 | + |
| 10 | +Method | HTTP request | Description |
| 11 | +------------- | ------------- | ------------- |
| 12 | +[**remove Access Control Entries**](AccessControlEntriesApi.md#remove Access Control Entries) | **DELETE** /{organization}/_apis/accesscontrolentries/{securityNamespaceId} | |
| 13 | +[**set Access Control Entries**](AccessControlEntriesApi.md#set Access Control Entries) | **POST** /{organization}/_apis/accesscontrolentries/{securityNamespaceId} | |
| 14 | + |
| 15 | + |
| 16 | +# **remove Access Control Entries** |
| 17 | +> bool remove Access Control Entries(securityNamespaceId, organization, apiVersion, token, descriptors) |
| 18 | +
|
| 19 | + |
| 20 | + |
| 21 | +Remove the specified ACEs from the ACL belonging to the specified token. |
| 22 | + |
| 23 | +### Example |
| 24 | +```dart |
| 25 | +import 'package:azure_devops_sdk/api.dart'; |
| 26 | +// TODO Configure OAuth2 access token for authorization: oauth2 |
| 27 | +//defaultApiClient.getAuthentication<OAuth>('oauth2').accessToken = 'YOUR_ACCESS_TOKEN'; |
| 28 | +
|
| 29 | +var api_instance = AccessControlEntriesApi(); |
| 30 | +var securityNamespaceId = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // String | Security namespace identifier. |
| 31 | +var organization = organization_example; // String | The name of the Azure DevOps organization. |
| 32 | +var apiVersion = apiVersion_example; // String | Version of the API to use. This should be set to '5.1' to use this version of the api. |
| 33 | +var token = token_example; // String | The token whose ACL should be modified. |
| 34 | +var descriptors = descriptors_example; // String | String containing a list of identity descriptors separated by ',' whose entries should be removed. |
| 35 | +
|
| 36 | +try { |
| 37 | + var result = api_instance.remove Access Control Entries(securityNamespaceId, organization, apiVersion, token, descriptors); |
| 38 | + print(result); |
| 39 | +} catch (e) { |
| 40 | + print("Exception when calling AccessControlEntriesApi->remove Access Control Entries: $e\n"); |
| 41 | +} |
| 42 | +``` |
| 43 | + |
| 44 | +### Parameters |
| 45 | + |
| 46 | +Name | Type | Description | Notes |
| 47 | +------------- | ------------- | ------------- | ------------- |
| 48 | + **securityNamespaceId** | [**String**](.md)| Security namespace identifier. | [default to null] |
| 49 | + **organization** | **String**| The name of the Azure DevOps organization. | [default to null] |
| 50 | + **apiVersion** | **String**| Version of the API to use. This should be set to '5.1' to use this version of the api. | [default to null] |
| 51 | + **token** | **String**| The token whose ACL should be modified. | [optional] [default to null] |
| 52 | + **descriptors** | **String**| String containing a list of identity descriptors separated by ',' whose entries should be removed. | [optional] [default to null] |
| 53 | + |
| 54 | +### Return type |
| 55 | + |
| 56 | +**bool** |
| 57 | + |
| 58 | +### Authorization |
| 59 | + |
| 60 | +[oauth2](../README.md#oauth2) |
| 61 | + |
| 62 | +### HTTP request headers |
| 63 | + |
| 64 | + - **Content-Type**: Not defined |
| 65 | + - **Accept**: application/json |
| 66 | + |
| 67 | +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) |
| 68 | + |
| 69 | +# **set Access Control Entries** |
| 70 | +> List<AccessControlEntry> set Access Control Entries(securityNamespaceId, organization, apiVersion, body) |
| 71 | +
|
| 72 | + |
| 73 | + |
| 74 | +Add or update ACEs in the ACL for the provided token. The request body contains the target token, a list of [ACEs](https://docs.microsoft.com/en-us/rest/api/azure/devops/security/access%20control%20entries/set%20access%20control%20entries?#accesscontrolentry) and a optional merge parameter. In the case of a collision (by identity descriptor) with an existing ACE in the ACL, the \"merge\" parameter determines the behavior. If set, the existing ACE has its allow and deny merged with the incoming ACE's allow and deny. If unset, the existing ACE is displaced. |
| 75 | + |
| 76 | +### Example |
| 77 | +```dart |
| 78 | +import 'package:azure_devops_sdk/api.dart'; |
| 79 | +// TODO Configure OAuth2 access token for authorization: oauth2 |
| 80 | +//defaultApiClient.getAuthentication<OAuth>('oauth2').accessToken = 'YOUR_ACCESS_TOKEN'; |
| 81 | +
|
| 82 | +var api_instance = AccessControlEntriesApi(); |
| 83 | +var securityNamespaceId = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // String | Security namespace identifier. |
| 84 | +var organization = organization_example; // String | The name of the Azure DevOps organization. |
| 85 | +var apiVersion = apiVersion_example; // String | Version of the API to use. This should be set to '5.1' to use this version of the api. |
| 86 | +var body = JObject(); // JObject | |
| 87 | +
|
| 88 | +try { |
| 89 | + var result = api_instance.set Access Control Entries(securityNamespaceId, organization, apiVersion, body); |
| 90 | + print(result); |
| 91 | +} catch (e) { |
| 92 | + print("Exception when calling AccessControlEntriesApi->set Access Control Entries: $e\n"); |
| 93 | +} |
| 94 | +``` |
| 95 | + |
| 96 | +### Parameters |
| 97 | + |
| 98 | +Name | Type | Description | Notes |
| 99 | +------------- | ------------- | ------------- | ------------- |
| 100 | + **securityNamespaceId** | [**String**](.md)| Security namespace identifier. | [default to null] |
| 101 | + **organization** | **String**| The name of the Azure DevOps organization. | [default to null] |
| 102 | + **apiVersion** | **String**| Version of the API to use. This should be set to '5.1' to use this version of the api. | [default to null] |
| 103 | + **body** | [**JObject**](JObject.md)| | |
| 104 | + |
| 105 | +### Return type |
| 106 | + |
| 107 | +[**List<AccessControlEntry>**](AccessControlEntry.md) |
| 108 | + |
| 109 | +### Authorization |
| 110 | + |
| 111 | +[oauth2](../README.md#oauth2) |
| 112 | + |
| 113 | +### HTTP request headers |
| 114 | + |
| 115 | + - **Content-Type**: application/json |
| 116 | + - **Accept**: application/json |
| 117 | + |
| 118 | +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) |
| 119 | + |
0 commit comments