# GisServerApIs.UsersApi

All URIs are relative to *https://localhost*

Method | HTTP request | Description
------------- | ------------- | -------------
[**apiV1UsersByUserIdDelete**](UsersApi.md#apiV1UsersByUserIdDelete) | **DELETE** /api/v1/users/{userId} | 
[**apiV1UsersByUserIdGet**](UsersApi.md#apiV1UsersByUserIdGet) | **GET** /api/v1/users/{userId} | 
[**apiV1UsersByUserIdPost**](UsersApi.md#apiV1UsersByUserIdPost) | **POST** /api/v1/users/{userId} | 
[**apiV1UsersByUserIdRestrictionsDelete**](UsersApi.md#apiV1UsersByUserIdRestrictionsDelete) | **DELETE** /api/v1/users/{userId}/restrictions | 
[**apiV1UsersByUserIdRestrictionsGet**](UsersApi.md#apiV1UsersByUserIdRestrictionsGet) | **GET** /api/v1/users/{userId}/restrictions | 
[**apiV1UsersByUserIdRestrictionsPost**](UsersApi.md#apiV1UsersByUserIdRestrictionsPost) | **POST** /api/v1/users/{userId}/restrictions | 
[**apiV1UsersByUserIdRolesDelete**](UsersApi.md#apiV1UsersByUserIdRolesDelete) | **DELETE** /api/v1/users/{userId}/roles | 
[**apiV1UsersByUserIdRolesPost**](UsersApi.md#apiV1UsersByUserIdRolesPost) | **POST** /api/v1/users/{userId}/roles | 
[**apiV1UsersChangepasswordPost**](UsersApi.md#apiV1UsersChangepasswordPost) | **POST** /api/v1/users/changepassword | 
[**apiV1UsersDelete**](UsersApi.md#apiV1UsersDelete) | **DELETE** /api/v1/users | 
[**apiV1UsersGet**](UsersApi.md#apiV1UsersGet) | **GET** /api/v1/users | 
[**apiV1UsersPost**](UsersApi.md#apiV1UsersPost) | **POST** /api/v1/users | 
[**apiV1UsersRestrictionByRestrictionIdGet**](UsersApi.md#apiV1UsersRestrictionByRestrictionIdGet) | **GET** /api/v1/users/restriction/{restrictionId} | 
[**apiV1UsersRoleByRoleIdGet**](UsersApi.md#apiV1UsersRoleByRoleIdGet) | **GET** /api/v1/users/role/{roleId} | 


<a name="apiV1UsersByUserIdDelete"></a>
# **apiV1UsersByUserIdDelete**
> apiV1UsersByUserIdDelete(userId)



### Example
```javascript
var GisServerApIs = require('gis_server_ap_is');

var apiInstance = new GisServerApIs.UsersApi();

var userId = "userId_example"; // String | 


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

### Parameters

Name | Type | Description  | Notes
------------- | ------------- | ------------- | -------------
 **userId** | **String**|  | 

### Return type

null (empty response body)

### Authorization

No authorization required

### HTTP request headers

 - **Content-Type**: Not defined
 - **Accept**: Not defined

<a name="apiV1UsersByUserIdGet"></a>
# **apiV1UsersByUserIdGet**
> ResponseUserResponse apiV1UsersByUserIdGet(userId)



### Example
```javascript
var GisServerApIs = require('gis_server_ap_is');

var apiInstance = new GisServerApIs.UsersApi();

var userId = "userId_example"; // String | 


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

### Parameters

Name | Type | Description  | Notes
------------- | ------------- | ------------- | -------------
 **userId** | **String**|  | 

### Return type

[**ResponseUserResponse**](ResponseUserResponse.md)

### Authorization

No authorization required

### HTTP request headers

 - **Content-Type**: Not defined
 - **Accept**: text/plain, application/json, text/json

<a name="apiV1UsersByUserIdPost"></a>
# **apiV1UsersByUserIdPost**
> ResponseUserResponse apiV1UsersByUserIdPost(userId, opts)



### Example
```javascript
var GisServerApIs = require('gis_server_ap_is');

var apiInstance = new GisServerApIs.UsersApi();

var userId = "userId_example"; // String | 

var opts = { 
  'user': new GisServerApIs.UserResource() // UserResource | 
};

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

### Parameters

Name | Type | Description  | Notes
------------- | ------------- | ------------- | -------------
 **userId** | **String**|  | 
 **user** | [**UserResource**](UserResource.md)|  | [optional] 

### Return type

[**ResponseUserResponse**](ResponseUserResponse.md)

### Authorization

No authorization required

### HTTP request headers

 - **Content-Type**: application/json, text/json, application/json-patch+json
 - **Accept**: text/plain, application/json, text/json

<a name="apiV1UsersByUserIdRestrictionsDelete"></a>
# **apiV1UsersByUserIdRestrictionsDelete**
> apiV1UsersByUserIdRestrictionsDelete(userId, opts)



### Example
```javascript
var GisServerApIs = require('gis_server_ap_is');

var apiInstance = new GisServerApIs.UsersApi();

var userId = "userId_example"; // String | 

var opts = { 
  'restrictionIds': ["restrictionIds_example"] // [String] | 
};

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

### Parameters

Name | Type | Description  | Notes
------------- | ------------- | ------------- | -------------
 **userId** | **String**|  | 
 **restrictionIds** | [**[String]**](String.md)|  | [optional] 

### Return type

null (empty response body)

### Authorization

No authorization required

### HTTP request headers

 - **Content-Type**: Not defined
 - **Accept**: Not defined

<a name="apiV1UsersByUserIdRestrictionsGet"></a>
# **apiV1UsersByUserIdRestrictionsGet**
> UserRestrictionsResponse apiV1UsersByUserIdRestrictionsGet(userId, opts)



### Example
```javascript
var GisServerApIs = require('gis_server_ap_is');

var apiInstance = new GisServerApIs.UsersApi();

var userId = "userId_example"; // String | 

var opts = { 
  'offset': 56, // Number | 
  'length': 56, // Number | 
  'returnMode': 56, // Number | 
  'whereClause': "whereClause_example" // String | 
};

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

### Parameters

Name | Type | Description  | Notes
------------- | ------------- | ------------- | -------------
 **userId** | **String**|  | 
 **offset** | **Number**|  | [optional] 
 **length** | **Number**|  | [optional] 
 **returnMode** | **Number**|  | [optional] 
 **whereClause** | **String**|  | [optional] 

### Return type

[**UserRestrictionsResponse**](UserRestrictionsResponse.md)

### Authorization

No authorization required

### HTTP request headers

 - **Content-Type**: Not defined
 - **Accept**: text/plain, application/json, text/json

<a name="apiV1UsersByUserIdRestrictionsPost"></a>
# **apiV1UsersByUserIdRestrictionsPost**
> apiV1UsersByUserIdRestrictionsPost(userId, opts)



### Example
```javascript
var GisServerApIs = require('gis_server_ap_is');

var apiInstance = new GisServerApIs.UsersApi();

var userId = "userId_example"; // String | 

var opts = { 
  'restrictionIds': ["restrictionIds_example"], // [String] | 
  'mapMode': 56 // Number | 
};

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

### Parameters

Name | Type | Description  | Notes
------------- | ------------- | ------------- | -------------
 **userId** | **String**|  | 
 **restrictionIds** | [**[String]**](String.md)|  | [optional] 
 **mapMode** | **Number**|  | [optional] 

### Return type

null (empty response body)

### Authorization

No authorization required

### HTTP request headers

 - **Content-Type**: Not defined
 - **Accept**: Not defined

<a name="apiV1UsersByUserIdRolesDelete"></a>
# **apiV1UsersByUserIdRolesDelete**
> apiV1UsersByUserIdRolesDelete(userId, opts)



### Example
```javascript
var GisServerApIs = require('gis_server_ap_is');

var apiInstance = new GisServerApIs.UsersApi();

var userId = "userId_example"; // String | 

var opts = { 
  'roleIds': ["roleIds_example"] // [String] | 
};

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

### Parameters

Name | Type | Description  | Notes
------------- | ------------- | ------------- | -------------
 **userId** | **String**|  | 
 **roleIds** | [**[String]**](String.md)|  | [optional] 

### Return type

null (empty response body)

### Authorization

No authorization required

### HTTP request headers

 - **Content-Type**: Not defined
 - **Accept**: Not defined

<a name="apiV1UsersByUserIdRolesPost"></a>
# **apiV1UsersByUserIdRolesPost**
> apiV1UsersByUserIdRolesPost(userId, opts)



### Example
```javascript
var GisServerApIs = require('gis_server_ap_is');

var apiInstance = new GisServerApIs.UsersApi();

var userId = "userId_example"; // String | 

var opts = { 
  'roleIds': ["roleIds_example"], // [String] | 
  'mapMode': 56 // Number | 
};

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

### Parameters

Name | Type | Description  | Notes
------------- | ------------- | ------------- | -------------
 **userId** | **String**|  | 
 **roleIds** | [**[String]**](String.md)|  | [optional] 
 **mapMode** | **Number**|  | [optional] 

### Return type

null (empty response body)

### Authorization

No authorization required

### HTTP request headers

 - **Content-Type**: Not defined
 - **Accept**: Not defined

<a name="apiV1UsersChangepasswordPost"></a>
# **apiV1UsersChangepasswordPost**
> ResponseObject apiV1UsersChangepasswordPost(opts)



### Example
```javascript
var GisServerApIs = require('gis_server_ap_is');

var apiInstance = new GisServerApIs.UsersApi();

var opts = { 
  'model': new GisServerApIs.ChangePasswordResource() // ChangePasswordResource | 
};

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

### Parameters

Name | Type | Description  | Notes
------------- | ------------- | ------------- | -------------
 **model** | [**ChangePasswordResource**](ChangePasswordResource.md)|  | [optional] 

### Return type

[**ResponseObject**](ResponseObject.md)

### Authorization

No authorization required

### HTTP request headers

 - **Content-Type**: application/json, text/json, application/json-patch+json
 - **Accept**: text/plain, application/json, text/json

<a name="apiV1UsersDelete"></a>
# **apiV1UsersDelete**
> apiV1UsersDelete(opts)



### Example
```javascript
var GisServerApIs = require('gis_server_ap_is');

var apiInstance = new GisServerApIs.UsersApi();

var opts = { 
  'userIds': ["userIds_example"] // [String] | 
};

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

### Parameters

Name | Type | Description  | Notes
------------- | ------------- | ------------- | -------------
 **userIds** | [**[String]**](String.md)|  | [optional] 

### Return type

null (empty response body)

### Authorization

No authorization required

### HTTP request headers

 - **Content-Type**: Not defined
 - **Accept**: Not defined

<a name="apiV1UsersGet"></a>
# **apiV1UsersGet**
> UsersResponse apiV1UsersGet(opts)



### Example
```javascript
var GisServerApIs = require('gis_server_ap_is');

var apiInstance = new GisServerApIs.UsersApi();

var opts = { 
  'offset': 56, // Number | 
  'length': 56, // Number | 
  'returnMode': 56, // Number | 
  'whereClause': "whereClause_example" // String | 
};

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

### Parameters

Name | Type | Description  | Notes
------------- | ------------- | ------------- | -------------
 **offset** | **Number**|  | [optional] 
 **length** | **Number**|  | [optional] 
 **returnMode** | **Number**|  | [optional] 
 **whereClause** | **String**|  | [optional] 

### Return type

[**UsersResponse**](UsersResponse.md)

### Authorization

No authorization required

### HTTP request headers

 - **Content-Type**: Not defined
 - **Accept**: text/plain, application/json, text/json

<a name="apiV1UsersPost"></a>
# **apiV1UsersPost**
> ResponseUserResponse apiV1UsersPost(opts)



### Example
```javascript
var GisServerApIs = require('gis_server_ap_is');

var apiInstance = new GisServerApIs.UsersApi();

var opts = { 
  'user': new GisServerApIs.RegisterUserResource() // RegisterUserResource | 
};

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

### Parameters

Name | Type | Description  | Notes
------------- | ------------- | ------------- | -------------
 **user** | [**RegisterUserResource**](RegisterUserResource.md)|  | [optional] 

### Return type

[**ResponseUserResponse**](ResponseUserResponse.md)

### Authorization

No authorization required

### HTTP request headers

 - **Content-Type**: application/json, text/json, application/json-patch+json
 - **Accept**: text/plain, application/json, text/json

<a name="apiV1UsersRestrictionByRestrictionIdGet"></a>
# **apiV1UsersRestrictionByRestrictionIdGet**
> UsersResponse apiV1UsersRestrictionByRestrictionIdGet(restrictionId, opts)



### Example
```javascript
var GisServerApIs = require('gis_server_ap_is');

var apiInstance = new GisServerApIs.UsersApi();

var restrictionId = "restrictionId_example"; // String | 

var opts = { 
  'offset': 56, // Number | 
  'length': 56, // Number | 
  'returnMode': 56, // Number | 
  'whereClause': "whereClause_example" // String | 
};

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

### Parameters

Name | Type | Description  | Notes
------------- | ------------- | ------------- | -------------
 **restrictionId** | **String**|  | 
 **offset** | **Number**|  | [optional] 
 **length** | **Number**|  | [optional] 
 **returnMode** | **Number**|  | [optional] 
 **whereClause** | **String**|  | [optional] 

### Return type

[**UsersResponse**](UsersResponse.md)

### Authorization

No authorization required

### HTTP request headers

 - **Content-Type**: Not defined
 - **Accept**: text/plain, application/json, text/json

<a name="apiV1UsersRoleByRoleIdGet"></a>
# **apiV1UsersRoleByRoleIdGet**
> UsersResponse apiV1UsersRoleByRoleIdGet(roleId, opts)



### Example
```javascript
var GisServerApIs = require('gis_server_ap_is');

var apiInstance = new GisServerApIs.UsersApi();

var roleId = "roleId_example"; // String | 

var opts = { 
  'offset': 56, // Number | 
  'length': 56, // Number | 
  'returnMode': 56, // Number | 
  'whereClause': "whereClause_example" // String | 
};

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

### Parameters

Name | Type | Description  | Notes
------------- | ------------- | ------------- | -------------
 **roleId** | **String**|  | 
 **offset** | **Number**|  | [optional] 
 **length** | **Number**|  | [optional] 
 **returnMode** | **Number**|  | [optional] 
 **whereClause** | **String**|  | [optional] 

### Return type

[**UsersResponse**](UsersResponse.md)

### Authorization

No authorization required

### HTTP request headers

 - **Content-Type**: Not defined
 - **Accept**: text/plain, application/json, text/json