# Cyclos4102Api.OperatorsApi
All URIs are relative to *https://demo.cyclos.org/api*
Method | HTTP request | Description
------------- | ------------- | -------------
[**getGeneralOperatorsDataForSearch**](OperatorsApi.md#getGeneralOperatorsDataForSearch) | **GET** /operators/data-for-search | Get configuration data for searching operators of any managed user
[**getUserOperatorsDataForSearch**](OperatorsApi.md#getUserOperatorsDataForSearch) | **GET** /{user}/operators/data-for-search | Get configuration data for searching operators of the given user
[**searchGeneralOperators**](OperatorsApi.md#searchGeneralOperators) | **GET** /operators | Search the visible operators (of any managed user)
[**searchUserOperators**](OperatorsApi.md#searchUserOperators) | **GET** /{user}/operators | Search the operators of a given user
# **getGeneralOperatorsDataForSearch**
> GeneralOperatorsDataForSearch getGeneralOperatorsDataForSearch(opts)
Get configuration data for searching operators of any managed user
Returns data with the current configuration regarding the search of operators of managed users. This is meant to be used by either administrators or brokers
### Example
```javascript
var Cyclos4102Api = require('cyclos_4102_api');
var apiInstance = new Cyclos4102Api.OperatorsApi();
var opts = {
'fields': ["fields_example"] // [String] | Select which fields to include on returned data. If nothing is set, all object fields are returned. Unprefixed field names will be handled like a whitelist (only listed fields will be included), while names starting with a minus (-) or exclamation mark (!) will be handled as blacklist (listed fields will not be included). This works for nesting as well. For example: `a,b.b1,c.-c1,c.-c2` will return the fields `a`, `b` (containing only the `b1` field) and `c` (containing all its fields except for `c1` or `c2`).
};
var callback = function(error, data, response) {
if (error) {
console.error(error);
} else {
console.log('API called successfully. Returned data: ' + data);
}
};
apiInstance.getGeneralOperatorsDataForSearch(opts, callback);
```
### Parameters
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**fields** | [**[String]**](String.md)| Select which fields to include on returned data. If nothing is set, all object fields are returned. Unprefixed field names will be handled like a whitelist (only listed fields will be included), while names starting with a minus (-) or exclamation mark (!) will be handled as blacklist (listed fields will not be included). This works for nesting as well. For example: `a,b.b1,c.-c1,c.-c2` will return the fields `a`, `b` (containing only the `b1` field) and `c` (containing all its fields except for `c1` or `c2`). | [optional]
### Return type
[**GeneralOperatorsDataForSearch**](GeneralOperatorsDataForSearch.md)
### Authorization
No authorization required
### HTTP request headers
- **Content-Type**: Not defined
- **Accept**: application/json
# **getUserOperatorsDataForSearch**
> UserOperatorsDataForSearch getUserOperatorsDataForSearch(user, opts)
Get configuration data for searching operators of the given user
Returns data with the current configuration regarding the operators of the given user
### Example
```javascript
var Cyclos4102Api = require('cyclos_4102_api');
var apiInstance = new Cyclos4102Api.OperatorsApi();
var user = "user_example"; // String | Can be one of: * a user identification value, such as id, username, e-mail, phone, etc. Id is always allowed, others depend on Cyclos configuration. Note that a valid numeric value is always considered as id. For example, when using another identification method that can be numeric only, prefix the value with a single quote (like in Excel spreadsheets), for example, `'1234567890`; * `self` for the currently authenticated user.
var opts = {
'fields': ["fields_example"] // [String] | Select which fields to include on returned data. If nothing is set, all object fields are returned. Unprefixed field names will be handled like a whitelist (only listed fields will be included), while names starting with a minus (-) or exclamation mark (!) will be handled as blacklist (listed fields will not be included). This works for nesting as well. For example: `a,b.b1,c.-c1,c.-c2` will return the fields `a`, `b` (containing only the `b1` field) and `c` (containing all its fields except for `c1` or `c2`).
};
var callback = function(error, data, response) {
if (error) {
console.error(error);
} else {
console.log('API called successfully. Returned data: ' + data);
}
};
apiInstance.getUserOperatorsDataForSearch(user, opts, callback);
```
### Parameters
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**user** | **String**| Can be one of: * a user identification value, such as id, username, e-mail, phone, etc. Id is always allowed, others depend on Cyclos configuration. Note that a valid numeric value is always considered as id. For example, when using another identification method that can be numeric only, prefix the value with a single quote (like in Excel spreadsheets), for example, `'1234567890`; * `self` for the currently authenticated user. |
**fields** | [**[String]**](String.md)| Select which fields to include on returned data. If nothing is set, all object fields are returned. Unprefixed field names will be handled like a whitelist (only listed fields will be included), while names starting with a minus (-) or exclamation mark (!) will be handled as blacklist (listed fields will not be included). This works for nesting as well. For example: `a,b.b1,c.-c1,c.-c2` will return the fields `a`, `b` (containing only the `b1` field) and `c` (containing all its fields except for `c1` or `c2`). | [optional]
### Return type
[**UserOperatorsDataForSearch**](UserOperatorsDataForSearch.md)
### Authorization
No authorization required
### HTTP request headers
- **Content-Type**: Not defined
- **Accept**: application/json
# **searchGeneralOperators**
> [UserResult] searchGeneralOperators(opts)
Search the visible operators (of any managed user)
Returns a page of operators that match a given criteria
### Example
```javascript
var Cyclos4102Api = require('cyclos_4102_api');
var apiInstance = new Cyclos4102Api.OperatorsApi();
var opts = {
'fields': ["fields_example"], // [String] | Select which fields to include on returned data. If nothing is set, all object fields are returned. Unprefixed field names will be handled like a whitelist (only listed fields will be included), while names starting with a minus (-) or exclamation mark (!) will be handled as blacklist (listed fields will not be included). This works for nesting as well. For example: `a,b.b1,c.-c1,c.-c2` will return the fields `a`, `b` (containing only the `b1` field) and `c` (containing all its fields except for `c1` or `c2`).
'page': 56, // Number | The page number (zero-based) of the search. The default value is zero.
'pageSize': 56, // Number | The maximum number of records that will be returned on the search. The default value is 40.
'userGroups': ["userGroups_example"], // [String] | Either id or internal names of user groups / group sets
'broker': "broker_example", // String | Either id or a principal (login name, e-mail, etc) of the user broker
'creationPeriod': [new Date("2013-10-20T19:20:30+01:00")], // [Date] | The minimum / maximum user creation date. Only taken into account if searching as administrator or managing broker. Is expressed an array, with the lower bound as first element, and the upper bound as second element. When only one element, will have just the lower bound. To specify only the upper bound, prefix the value with a comma.
'statuses': ["statuses_example"] // [String] | The possible statuses for an user Possible values for each array element are: * active: The user is active and can use the system normally. * blocked: The user has been blocked from accessing the system. Other users still see him/her. * disabled: The user has been disabled - he/she cannot access the system and is invisible by other users. * pending: The user registration is pending a confirmation. Probably the user has received an e-mail with a link that must be followed to complete the activation. The user is invisible by other users. * removed: The user was permanently removed. It's profile is kept for historical purposes.
};
var callback = function(error, data, response) {
if (error) {
console.error(error);
} else {
console.log('API called successfully. Returned data: ' + data);
}
};
apiInstance.searchGeneralOperators(opts, callback);
```
### Parameters
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**fields** | [**[String]**](String.md)| Select which fields to include on returned data. If nothing is set, all object fields are returned. Unprefixed field names will be handled like a whitelist (only listed fields will be included), while names starting with a minus (-) or exclamation mark (!) will be handled as blacklist (listed fields will not be included). This works for nesting as well. For example: `a,b.b1,c.-c1,c.-c2` will return the fields `a`, `b` (containing only the `b1` field) and `c` (containing all its fields except for `c1` or `c2`). | [optional]
**page** | **Number**| The page number (zero-based) of the search. The default value is zero. | [optional]
**pageSize** | **Number**| The maximum number of records that will be returned on the search. The default value is 40. | [optional]
**userGroups** | [**[String]**](String.md)| Either id or internal names of user groups / group sets | [optional]
**broker** | **String**| Either id or a principal (login name, e-mail, etc) of the user broker | [optional]
**creationPeriod** | [**[Date]**](Date.md)| The minimum / maximum user creation date. Only taken into account if searching as administrator or managing broker. Is expressed an array, with the lower bound as first element, and the upper bound as second element. When only one element, will have just the lower bound. To specify only the upper bound, prefix the value with a comma. | [optional]
**statuses** | [**[String]**](String.md)| The possible statuses for an user Possible values for each array element are: * active: The user is active and can use the system normally. * blocked: The user has been blocked from accessing the system. Other users still see him/her. * disabled: The user has been disabled - he/she cannot access the system and is invisible by other users. * pending: The user registration is pending a confirmation. Probably the user has received an e-mail with a link that must be followed to complete the activation. The user is invisible by other users. * removed: The user was permanently removed. It's profile is kept for historical purposes. | [optional]
### Return type
[**[UserResult]**](UserResult.md)
### Authorization
No authorization required
### HTTP request headers
- **Content-Type**: Not defined
- **Accept**: application/json
# **searchUserOperators**
> [UserResult] searchUserOperators(user, opts)
Search the operators of a given user
Returns a page of operators that match a given criteria
### Example
```javascript
var Cyclos4102Api = require('cyclos_4102_api');
var apiInstance = new Cyclos4102Api.OperatorsApi();
var user = "user_example"; // String | Can be one of: * a user identification value, such as id, username, e-mail, phone, etc. Id is always allowed, others depend on Cyclos configuration. Note that a valid numeric value is always considered as id. For example, when using another identification method that can be numeric only, prefix the value with a single quote (like in Excel spreadsheets), for example, `'1234567890`; * `self` for the currently authenticated user.
var opts = {
'fields': ["fields_example"], // [String] | Select which fields to include on returned data. If nothing is set, all object fields are returned. Unprefixed field names will be handled like a whitelist (only listed fields will be included), while names starting with a minus (-) or exclamation mark (!) will be handled as blacklist (listed fields will not be included). This works for nesting as well. For example: `a,b.b1,c.-c1,c.-c2` will return the fields `a`, `b` (containing only the `b1` field) and `c` (containing all its fields except for `c1` or `c2`).
'creationPeriod': [new Date("2013-10-20T19:20:30+01:00")], // [Date] | The minimum / maximum user creation date. Only taken into account if searching as administrator or managing broker. Is expressed an array, with the lower bound as first element, and the upper bound as second element. When only one element, will have just the lower bound. To specify only the upper bound, prefix the value with a comma.
'ignoreProfileFieldsInList': true, // Boolean | When set to `true`, instead of returning users with corresponding profile fields set on list, will return them with `display` and `shortDisplay`.
'operatorGroups': ["operatorGroups_example"], // [String] | An array of operator group ids
'page': 56, // Number | The page number (zero-based) of the search. The default value is zero.
'pageSize': 56, // Number | The maximum number of records that will be returned on the search. The default value is 40. The maximum number of returned results is configured in Cyclos, and even if more than that is requested, it will be limited by that setting.
'statuses': ["statuses_example"] // [String] | The possible statuses for an user Possible values for each array element are: * active: The user is active and can use the system normally. * blocked: The user has been blocked from accessing the system. Other users still see him/her. * disabled: The user has been disabled - he/she cannot access the system and is invisible by other users. * pending: The user registration is pending a confirmation. Probably the user has received an e-mail with a link that must be followed to complete the activation. The user is invisible by other users. * removed: The user was permanently removed. It's profile is kept for historical purposes.
};
var callback = function(error, data, response) {
if (error) {
console.error(error);
} else {
console.log('API called successfully. Returned data: ' + data);
}
};
apiInstance.searchUserOperators(user, opts, callback);
```
### Parameters
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**user** | **String**| Can be one of: * a user identification value, such as id, username, e-mail, phone, etc. Id is always allowed, others depend on Cyclos configuration. Note that a valid numeric value is always considered as id. For example, when using another identification method that can be numeric only, prefix the value with a single quote (like in Excel spreadsheets), for example, `'1234567890`; * `self` for the currently authenticated user. |
**fields** | [**[String]**](String.md)| Select which fields to include on returned data. If nothing is set, all object fields are returned. Unprefixed field names will be handled like a whitelist (only listed fields will be included), while names starting with a minus (-) or exclamation mark (!) will be handled as blacklist (listed fields will not be included). This works for nesting as well. For example: `a,b.b1,c.-c1,c.-c2` will return the fields `a`, `b` (containing only the `b1` field) and `c` (containing all its fields except for `c1` or `c2`). | [optional]
**creationPeriod** | [**[Date]**](Date.md)| The minimum / maximum user creation date. Only taken into account if searching as administrator or managing broker. Is expressed an array, with the lower bound as first element, and the upper bound as second element. When only one element, will have just the lower bound. To specify only the upper bound, prefix the value with a comma. | [optional]
**ignoreProfileFieldsInList** | **Boolean**| When set to `true`, instead of returning users with corresponding profile fields set on list, will return them with `display` and `shortDisplay`. | [optional]
**operatorGroups** | [**[String]**](String.md)| An array of operator group ids | [optional]
**page** | **Number**| The page number (zero-based) of the search. The default value is zero. | [optional]
**pageSize** | **Number**| The maximum number of records that will be returned on the search. The default value is 40. The maximum number of returned results is configured in Cyclos, and even if more than that is requested, it will be limited by that setting. | [optional]
**statuses** | [**[String]**](String.md)| The possible statuses for an user Possible values for each array element are: * active: The user is active and can use the system normally. * blocked: The user has been blocked from accessing the system. Other users still see him/her. * disabled: The user has been disabled - he/she cannot access the system and is invisible by other users. * pending: The user registration is pending a confirmation. Probably the user has received an e-mail with a link that must be followed to complete the activation. The user is invisible by other users. * removed: The user was permanently removed. It's profile is kept for historical purposes. | [optional]
### Return type
[**[UserResult]**](UserResult.md)
### Authorization
No authorization required
### HTTP request headers
- **Content-Type**: Not defined
- **Accept**: application/json