# WeaviateApi.AclEntriesApi

All URIs are relative to *https://localhost/weaviate/v1-alpha*

Method | HTTP request | Description
------------- | ------------- | -------------
[**weaveAclEntriesDelete**](AclEntriesApi.md#weaveAclEntriesDelete) | **DELETE** /devices/{deviceId}/aclEntries/{aclEntryId} | 
[**weaveAclEntriesGet**](AclEntriesApi.md#weaveAclEntriesGet) | **GET** /devices/{deviceId}/aclEntries/{aclEntryId} | 
[**weaveAclEntriesInsert**](AclEntriesApi.md#weaveAclEntriesInsert) | **POST** /devices/{deviceId}/aclEntries | 
[**weaveAclEntriesList**](AclEntriesApi.md#weaveAclEntriesList) | **GET** /devices/{deviceId}/aclEntries | 
[**weaveAclEntriesPatch**](AclEntriesApi.md#weaveAclEntriesPatch) | **PATCH** /devices/{deviceId}/aclEntries/{aclEntryId} | 
[**weaveAclEntriesUpdate**](AclEntriesApi.md#weaveAclEntriesUpdate) | **PUT** /devices/{deviceId}/aclEntries/{aclEntryId} | 


<a name="weaveAclEntriesDelete"></a>
# **weaveAclEntriesDelete**
> weaveAclEntriesDelete(deviceId, aclEntryId, opts)



Deletes an ACL entry.

### Example
```javascript
var WeaviateApi = require('weaviate_api');
var defaultClient = WeaviateApi.ApiClient.default;

// Configure API key authorization: apiKey
var apiKey = defaultClient.authentications['apiKey'];
apiKey.apiKey = 'YOUR API KEY';
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//apiKey.apiKeyPrefix = 'Token';

var apiInstance = new WeaviateApi.AclEntriesApi();

var deviceId = "deviceId_example"; // String | ID of the device to use.

var aclEntryId = "aclEntryId_example"; // String | Unique ACL entry ID.

var opts = { 
  'alt': "json", // String | Data format for the response.
  'fields': "fields_example", // String | Selector specifying which fields to include in a partial response.
  'key': "key_example", // String | API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
  'oauthToken': "oauthToken_example", // String | OAuth 2.0 token for the current user.
  'prettyPrint': true, // Boolean | Returns response with indentations and line breaks.
  'quotaUser': "quotaUser_example", // String | Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. Overrides userIp if both are provided.
  'userIp': "userIp_example", // String | IP address of the site where the request originates. Use this if you want to enforce per-user limits.
  'hl': "hl_example" // String | Specifies the language code that should be used for text values in the API response.
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
apiInstance.weaveAclEntriesDelete(deviceId, aclEntryId, opts, callback);
```

### Parameters

Name | Type | Description  | Notes
------------- | ------------- | ------------- | -------------
 **deviceId** | **String**| ID of the device to use. | 
 **aclEntryId** | **String**| Unique ACL entry ID. | 
 **alt** | **String**| Data format for the response. | [optional] [default to json]
 **fields** | **String**| Selector specifying which fields to include in a partial response. | [optional] 
 **key** | **String**| API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. | [optional] 
 **oauthToken** | **String**| OAuth 2.0 token for the current user. | [optional] 
 **prettyPrint** | **Boolean**| Returns response with indentations and line breaks. | [optional] [default to true]
 **quotaUser** | **String**| Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. Overrides userIp if both are provided. | [optional] 
 **userIp** | **String**| IP address of the site where the request originates. Use this if you want to enforce per-user limits. | [optional] 
 **hl** | **String**| Specifies the language code that should be used for text values in the API response. | [optional] 

### Return type

null (empty response body)

### Authorization

[apiKey](../README.md#apiKey)

### HTTP request headers

 - **Content-Type**: application/json, application/protobuf, application/xml
 - **Accept**: application/json, application/protobuf, application/xml

<a name="weaveAclEntriesGet"></a>
# **weaveAclEntriesGet**
> AclEntry weaveAclEntriesGet(deviceId, aclEntryId, opts)



Returns the requested ACL entry.

### Example
```javascript
var WeaviateApi = require('weaviate_api');
var defaultClient = WeaviateApi.ApiClient.default;

// Configure API key authorization: apiKey
var apiKey = defaultClient.authentications['apiKey'];
apiKey.apiKey = 'YOUR API KEY';
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//apiKey.apiKeyPrefix = 'Token';

var apiInstance = new WeaviateApi.AclEntriesApi();

var deviceId = "deviceId_example"; // String | ID of the device to use.

var aclEntryId = "aclEntryId_example"; // String | Unique ACL entry ID.

var opts = { 
  'alt': "json", // String | Data format for the response.
  'fields': "fields_example", // String | Selector specifying which fields to include in a partial response.
  'key': "key_example", // String | API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
  'oauthToken': "oauthToken_example", // String | OAuth 2.0 token for the current user.
  'prettyPrint': true, // Boolean | Returns response with indentations and line breaks.
  'quotaUser': "quotaUser_example", // String | Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. Overrides userIp if both are provided.
  'userIp': "userIp_example", // String | IP address of the site where the request originates. Use this if you want to enforce per-user limits.
  'hl': "hl_example" // String | Specifies the language code that should be used for text values in the API response.
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
apiInstance.weaveAclEntriesGet(deviceId, aclEntryId, opts, callback);
```

### Parameters

Name | Type | Description  | Notes
------------- | ------------- | ------------- | -------------
 **deviceId** | **String**| ID of the device to use. | 
 **aclEntryId** | **String**| Unique ACL entry ID. | 
 **alt** | **String**| Data format for the response. | [optional] [default to json]
 **fields** | **String**| Selector specifying which fields to include in a partial response. | [optional] 
 **key** | **String**| API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. | [optional] 
 **oauthToken** | **String**| OAuth 2.0 token for the current user. | [optional] 
 **prettyPrint** | **Boolean**| Returns response with indentations and line breaks. | [optional] [default to true]
 **quotaUser** | **String**| Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. Overrides userIp if both are provided. | [optional] 
 **userIp** | **String**| IP address of the site where the request originates. Use this if you want to enforce per-user limits. | [optional] 
 **hl** | **String**| Specifies the language code that should be used for text values in the API response. | [optional] 

### Return type

[**AclEntry**](AclEntry.md)

### Authorization

[apiKey](../README.md#apiKey)

### HTTP request headers

 - **Content-Type**: application/json, application/protobuf, application/xml
 - **Accept**: application/json, application/protobuf, application/xml

<a name="weaveAclEntriesInsert"></a>
# **weaveAclEntriesInsert**
> AclEntry weaveAclEntriesInsert(deviceId, opts)



Inserts a new ACL entry.

### Example
```javascript
var WeaviateApi = require('weaviate_api');
var defaultClient = WeaviateApi.ApiClient.default;

// Configure API key authorization: apiKey
var apiKey = defaultClient.authentications['apiKey'];
apiKey.apiKey = 'YOUR API KEY';
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//apiKey.apiKeyPrefix = 'Token';

var apiInstance = new WeaviateApi.AclEntriesApi();

var deviceId = "deviceId_example"; // String | ID of the device to use.

var opts = { 
  'alt': "json", // String | Data format for the response.
  'fields': "fields_example", // String | Selector specifying which fields to include in a partial response.
  'key': "key_example", // String | API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
  'oauthToken': "oauthToken_example", // String | OAuth 2.0 token for the current user.
  'prettyPrint': true, // Boolean | Returns response with indentations and line breaks.
  'quotaUser': "quotaUser_example", // String | Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. Overrides userIp if both are provided.
  'userIp': "userIp_example", // String | IP address of the site where the request originates. Use this if you want to enforce per-user limits.
  'hl': "hl_example", // String | Specifies the language code that should be used for text values in the API response.
  'body': new WeaviateApi.AclEntry() // AclEntry | 
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
apiInstance.weaveAclEntriesInsert(deviceId, opts, callback);
```

### Parameters

Name | Type | Description  | Notes
------------- | ------------- | ------------- | -------------
 **deviceId** | **String**| ID of the device to use. | 
 **alt** | **String**| Data format for the response. | [optional] [default to json]
 **fields** | **String**| Selector specifying which fields to include in a partial response. | [optional] 
 **key** | **String**| API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. | [optional] 
 **oauthToken** | **String**| OAuth 2.0 token for the current user. | [optional] 
 **prettyPrint** | **Boolean**| Returns response with indentations and line breaks. | [optional] [default to true]
 **quotaUser** | **String**| Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. Overrides userIp if both are provided. | [optional] 
 **userIp** | **String**| IP address of the site where the request originates. Use this if you want to enforce per-user limits. | [optional] 
 **hl** | **String**| Specifies the language code that should be used for text values in the API response. | [optional] 
 **body** | [**AclEntry**](AclEntry.md)|  | [optional] 

### Return type

[**AclEntry**](AclEntry.md)

### Authorization

[apiKey](../README.md#apiKey)

### HTTP request headers

 - **Content-Type**: application/json, application/protobuf, application/xml
 - **Accept**: application/json, application/protobuf, application/xml

<a name="weaveAclEntriesList"></a>
# **weaveAclEntriesList**
> AclEntriesListResponse weaveAclEntriesList(deviceId, opts)



Lists ACL entries.

### Example
```javascript
var WeaviateApi = require('weaviate_api');
var defaultClient = WeaviateApi.ApiClient.default;

// Configure API key authorization: apiKey
var apiKey = defaultClient.authentications['apiKey'];
apiKey.apiKey = 'YOUR API KEY';
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//apiKey.apiKeyPrefix = 'Token';

var apiInstance = new WeaviateApi.AclEntriesApi();

var deviceId = "deviceId_example"; // String | ID of the device to use.

var opts = { 
  'alt': "json", // String | Data format for the response.
  'fields': "fields_example", // String | Selector specifying which fields to include in a partial response.
  'key': "key_example", // String | API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
  'oauthToken': "oauthToken_example", // String | OAuth 2.0 token for the current user.
  'prettyPrint': true, // Boolean | Returns response with indentations and line breaks.
  'quotaUser': "quotaUser_example", // String | Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. Overrides userIp if both are provided.
  'userIp': "userIp_example", // String | IP address of the site where the request originates. Use this if you want to enforce per-user limits.
  'hl': "hl_example", // String | Specifies the language code that should be used for text values in the API response.
  'maxResults': 56, // Number | 
  'startIndex': 56, // Number | 
  'token': "token_example" // String | 
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
apiInstance.weaveAclEntriesList(deviceId, opts, callback);
```

### Parameters

Name | Type | Description  | Notes
------------- | ------------- | ------------- | -------------
 **deviceId** | **String**| ID of the device to use. | 
 **alt** | **String**| Data format for the response. | [optional] [default to json]
 **fields** | **String**| Selector specifying which fields to include in a partial response. | [optional] 
 **key** | **String**| API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. | [optional] 
 **oauthToken** | **String**| OAuth 2.0 token for the current user. | [optional] 
 **prettyPrint** | **Boolean**| Returns response with indentations and line breaks. | [optional] [default to true]
 **quotaUser** | **String**| Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. Overrides userIp if both are provided. | [optional] 
 **userIp** | **String**| IP address of the site where the request originates. Use this if you want to enforce per-user limits. | [optional] 
 **hl** | **String**| Specifies the language code that should be used for text values in the API response. | [optional] 
 **maxResults** | **Number**|  | [optional] 
 **startIndex** | **Number**|  | [optional] 
 **token** | **String**|  | [optional] 

### Return type

[**AclEntriesListResponse**](AclEntriesListResponse.md)

### Authorization

[apiKey](../README.md#apiKey)

### HTTP request headers

 - **Content-Type**: application/json, application/protobuf, application/xml
 - **Accept**: application/json, application/protobuf, application/xml

<a name="weaveAclEntriesPatch"></a>
# **weaveAclEntriesPatch**
> AclEntry weaveAclEntriesPatch(deviceId, aclEntryId, opts)



Update an ACL entry. This method supports patch semantics.

### Example
```javascript
var WeaviateApi = require('weaviate_api');
var defaultClient = WeaviateApi.ApiClient.default;

// Configure API key authorization: apiKey
var apiKey = defaultClient.authentications['apiKey'];
apiKey.apiKey = 'YOUR API KEY';
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//apiKey.apiKeyPrefix = 'Token';

var apiInstance = new WeaviateApi.AclEntriesApi();

var deviceId = "deviceId_example"; // String | ID of the device to use.

var aclEntryId = "aclEntryId_example"; // String | Unique ACL entry ID.

var opts = { 
  'alt': "json", // String | Data format for the response.
  'fields': "fields_example", // String | Selector specifying which fields to include in a partial response.
  'key': "key_example", // String | API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
  'oauthToken': "oauthToken_example", // String | OAuth 2.0 token for the current user.
  'prettyPrint': true, // Boolean | Returns response with indentations and line breaks.
  'quotaUser': "quotaUser_example", // String | Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. Overrides userIp if both are provided.
  'userIp': "userIp_example", // String | IP address of the site where the request originates. Use this if you want to enforce per-user limits.
  'hl': "hl_example", // String | Specifies the language code that should be used for text values in the API response.
  'body': new WeaviateApi.AclEntry() // AclEntry | 
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
apiInstance.weaveAclEntriesPatch(deviceId, aclEntryId, opts, callback);
```

### Parameters

Name | Type | Description  | Notes
------------- | ------------- | ------------- | -------------
 **deviceId** | **String**| ID of the device to use. | 
 **aclEntryId** | **String**| Unique ACL entry ID. | 
 **alt** | **String**| Data format for the response. | [optional] [default to json]
 **fields** | **String**| Selector specifying which fields to include in a partial response. | [optional] 
 **key** | **String**| API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. | [optional] 
 **oauthToken** | **String**| OAuth 2.0 token for the current user. | [optional] 
 **prettyPrint** | **Boolean**| Returns response with indentations and line breaks. | [optional] [default to true]
 **quotaUser** | **String**| Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. Overrides userIp if both are provided. | [optional] 
 **userIp** | **String**| IP address of the site where the request originates. Use this if you want to enforce per-user limits. | [optional] 
 **hl** | **String**| Specifies the language code that should be used for text values in the API response. | [optional] 
 **body** | [**AclEntry**](AclEntry.md)|  | [optional] 

### Return type

[**AclEntry**](AclEntry.md)

### Authorization

[apiKey](../README.md#apiKey)

### HTTP request headers

 - **Content-Type**: application/json, application/protobuf, application/xml
 - **Accept**: application/json, application/protobuf, application/xml

<a name="weaveAclEntriesUpdate"></a>
# **weaveAclEntriesUpdate**
> AclEntry weaveAclEntriesUpdate(deviceId, aclEntryId, opts)



Update an ACL entry.

### Example
```javascript
var WeaviateApi = require('weaviate_api');
var defaultClient = WeaviateApi.ApiClient.default;

// Configure API key authorization: apiKey
var apiKey = defaultClient.authentications['apiKey'];
apiKey.apiKey = 'YOUR API KEY';
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//apiKey.apiKeyPrefix = 'Token';

var apiInstance = new WeaviateApi.AclEntriesApi();

var deviceId = "deviceId_example"; // String | ID of the device to use.

var aclEntryId = "aclEntryId_example"; // String | Unique ACL entry ID.

var opts = { 
  'alt': "json", // String | Data format for the response.
  'fields': "fields_example", // String | Selector specifying which fields to include in a partial response.
  'key': "key_example", // String | API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
  'oauthToken': "oauthToken_example", // String | OAuth 2.0 token for the current user.
  'prettyPrint': true, // Boolean | Returns response with indentations and line breaks.
  'quotaUser': "quotaUser_example", // String | Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. Overrides userIp if both are provided.
  'userIp': "userIp_example", // String | IP address of the site where the request originates. Use this if you want to enforce per-user limits.
  'hl': "hl_example", // String | Specifies the language code that should be used for text values in the API response.
  'body': new WeaviateApi.AclEntry() // AclEntry | 
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
apiInstance.weaveAclEntriesUpdate(deviceId, aclEntryId, opts, callback);
```

### Parameters

Name | Type | Description  | Notes
------------- | ------------- | ------------- | -------------
 **deviceId** | **String**| ID of the device to use. | 
 **aclEntryId** | **String**| Unique ACL entry ID. | 
 **alt** | **String**| Data format for the response. | [optional] [default to json]
 **fields** | **String**| Selector specifying which fields to include in a partial response. | [optional] 
 **key** | **String**| API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. | [optional] 
 **oauthToken** | **String**| OAuth 2.0 token for the current user. | [optional] 
 **prettyPrint** | **Boolean**| Returns response with indentations and line breaks. | [optional] [default to true]
 **quotaUser** | **String**| Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. Overrides userIp if both are provided. | [optional] 
 **userIp** | **String**| IP address of the site where the request originates. Use this if you want to enforce per-user limits. | [optional] 
 **hl** | **String**| Specifies the language code that should be used for text values in the API response. | [optional] 
 **body** | [**AclEntry**](AclEntry.md)|  | [optional] 

### Return type

[**AclEntry**](AclEntry.md)

### Authorization

[apiKey](../README.md#apiKey)

### HTTP request headers

 - **Content-Type**: application/json, application/protobuf, application/xml
 - **Accept**: application/json, application/protobuf, application/xml