Skip to content

Latest commit

 

History

History
1318 lines (928 loc) · 51 KB

LUMADBLocalFeedApi.md

File metadata and controls

1318 lines (928 loc) · 51 KB

Onepanel.LUMADBLocalFeedApi

All URIs are relative to https://localhost/api/v3/onepanel

Method HTTP request Description
localFeedAddOnedataUserToCredentialsMapping POST /provider/storages/{id}/luma/local_feed/storage_access/all/onedata_user_to_credentials Insert Onedata user to credentials mapping into local feed
localFeedGetAclGroupToOnedataGroupMapping GET /provider/storages/{id}/luma/local_feed/storage_import/posix_compatible/acl_group_to_onedata_group/{groupname} Lookup mapping of ACL group in local feed
localFeedGetAclUserToOnedataUserMapping GET /provider/storages/{id}/luma/local_feed/storage_import/posix_compatible/acl_user_to_onedata_user/{username} Lookup mapping of ACL user in local feed
localFeedGetDefaultPosixCredentials GET /provider/storages/{id}/luma/local_feed/storage_access/posix_compatible/default_credentials/{space_id} Lookup default posix credentials in local feed
localFeedGetDisplayCredentials GET /provider/storages/{id}/luma/local_feed/display_credentials/all/default/{space_id} Lookup default display credentials in local feed
localFeedGetOnedataUserToCredentialsMapping GET /provider/storages/{id}/luma/local_feed/storage_access/all/onedata_user_to_credentials/{onedata_user_id} Lookup Onedata user to credentials mapping in local feed
localFeedGetUidToOnedataUserMapping GET /provider/storages/{id}/luma/local_feed/storage_import/posix_compatible/uid_to_onedata_user/{uid} Lookup mapping of UID in local feed
localFeedModifyOnedataUserToCredentialsMapping PATCH /provider/storages/{id}/luma/local_feed/storage_access/all/onedata_user_to_credentials/{onedata_user_id} Update Onedata user to credentials mapping in local feed
localFeedRemoveAclGroupToOnedataGroupMapping DELETE /provider/storages/{id}/luma/local_feed/storage_import/posix_compatible/acl_group_to_onedata_group/{groupname} Remove mapping of ACL group from local feed
localFeedRemoveAclUserToOnedataUserMapping DELETE /provider/storages/{id}/luma/local_feed/storage_import/posix_compatible/acl_user_to_onedata_user/{username} Remove mapping of ACL user from local feed
localFeedRemoveDefaultPosixCredentials DELETE /provider/storages/{id}/luma/local_feed/storage_access/posix_compatible/default_credentials/{space_id} Remove default posix credentials from local feed
localFeedRemoveDisplayCredentials DELETE /provider/storages/{id}/luma/local_feed/display_credentials/all/default/{space_id} Remove default display credentials from local feed
localFeedRemoveOnedataUserToCredentialsMapping DELETE /provider/storages/{id}/luma/local_feed/storage_access/all/onedata_user_to_credentials/{onedata_user_id} Remove Onedata user to credentials mapping from local feed
localFeedRemoveUidToOnedataUserMapping DELETE /provider/storages/{id}/luma/local_feed/storage_import/posix_compatible/uid_to_onedata_user/{uid} Remove mapping of UID from local feed
localFeedSetAclGroupToOnedataGroupMapping PUT /provider/storages/{id}/luma/local_feed/storage_import/posix_compatible/acl_group_to_onedata_group/{groupname} Insert mapping of ACL group into local feed
localFeedSetAclUserToOnedataUserMapping PUT /provider/storages/{id}/luma/local_feed/storage_import/posix_compatible/acl_user_to_onedata_user/{username} Insert mapping of ACL user into local feed
localFeedSetDefaultPosixCredentials PUT /provider/storages/{id}/luma/local_feed/storage_access/posix_compatible/default_credentials/{space_id} Insert default posix credentials into local feed
localFeedSetDisplayCredentials PUT /provider/storages/{id}/luma/local_feed/display_credentials/all/default/{space_id} Insert default display credentials into local feed
localFeedSetUidToOnedataUserMapping PUT /provider/storages/{id}/luma/local_feed/storage_import/posix_compatible/uid_to_onedata_user/{uid} Insert mapping of UID into local feed

localFeedAddOnedataUserToCredentialsMapping

localFeedAddOnedataUserToCredentialsMapping(id, userMapping)

Insert Onedata user to credentials mapping into local feed

Adds mapping of Onedata user to user on the specific storage to local feed. Returns an error if the storage has a different LUMA feed than `local`.

Example

var Onepanel = require('onepanel');
var defaultClient = Onepanel.ApiClient.instance;

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

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

// Configure HTTP basic authorization: basic
var basic = defaultClient.authentications['basic'];
basic.username = 'YOUR USERNAME';
basic.password = 'YOUR PASSWORD';

var apiInstance = new Onepanel.LUMADBLocalFeedApi();

var id = "id_example"; // String | The Id of a storage for which user mapping should be added. 

var userMapping = new Onepanel.LumaUserMapping(); // LumaUserMapping | New user mapping 


var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
apiInstance.localFeedAddOnedataUserToCredentialsMapping(id, userMapping, callback);

Parameters

Name Type Description Notes
id String The Id of a storage for which user mapping should be added.
userMapping LumaUserMapping New user mapping

Return type

null (empty response body)

Authorization

api_key1, api_key2, basic

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

localFeedGetAclGroupToOnedataGroupMapping

LumaOnedataGroup localFeedGetAclGroupToOnedataGroupMapping(id, groupname)

Lookup mapping of ACL group in local feed

Returns mapping of ACL group on the specific storage to Onedata group defined in local feed. Returns an error if the storage has a different LUMA feed than `local`. This endpoint is relevant only for POSIX compatible storages.

Example

var Onepanel = require('onepanel');
var defaultClient = Onepanel.ApiClient.instance;

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

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

// Configure HTTP basic authorization: basic
var basic = defaultClient.authentications['basic'];
basic.username = 'YOUR USERNAME';
basic.password = 'YOUR PASSWORD';

var apiInstance = new Onepanel.LUMADBLocalFeedApi();

var id = "id_example"; // String | The Id of a storage constituting space support for which onedata group mapping should be returned. 

var groupname = 56; // Number | The ACL name of the group on the storage. 


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

Parameters

Name Type Description Notes
id String The Id of a storage constituting space support for which onedata group mapping should be returned.
groupname Number The ACL name of the group on the storage.

Return type

LumaOnedataGroup

Authorization

api_key1, api_key2, basic

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

localFeedGetAclUserToOnedataUserMapping

LumaOnedataUser localFeedGetAclUserToOnedataUserMapping(id, username)

Lookup mapping of ACL user in local feed

Returns mapping of ACL user on the specific storage to Onedata user defined in local feed. Returns an error if the storage has a different LUMA feed than `local`. This endpoint is relevant only for POSIX compatible storages.

Example

var Onepanel = require('onepanel');
var defaultClient = Onepanel.ApiClient.instance;

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

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

// Configure HTTP basic authorization: basic
var basic = defaultClient.authentications['basic'];
basic.username = 'YOUR USERNAME';
basic.password = 'YOUR PASSWORD';

var apiInstance = new Onepanel.LUMADBLocalFeedApi();

var id = "id_example"; // String | The Id of a storage constituting space support for which onedata user mapping should be returned. 

var username = 56; // Number | The ACL name of the user on the storage. 


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

Parameters

Name Type Description Notes
id String The Id of a storage constituting space support for which onedata user mapping should be returned.
username Number The ACL name of the user on the storage.

Return type

LumaOnedataUser

Authorization

api_key1, api_key2, basic

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

localFeedGetDefaultPosixCredentials

PosixCompatibleCredentials localFeedGetDefaultPosixCredentials(id, spaceId)

Lookup default posix credentials in local feed

Returns default storage credentials for the space supported by POSIX-compatible storage that are defined in local feed. GID will be used as a component of storage credentials for each member of the space. Both UID and GID will be used as to represent owner of the space directory on storage. Returns an error if the storage has a different LUMA feed than `local`. This endpoint is relevant only for POSIX compatible storages.

Example

var Onepanel = require('onepanel');
var defaultClient = Onepanel.ApiClient.instance;

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

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

// Configure HTTP basic authorization: basic
var basic = defaultClient.authentications['basic'];
basic.username = 'YOUR USERNAME';
basic.password = 'YOUR PASSWORD';

var apiInstance = new Onepanel.LUMADBLocalFeedApi();

var id = "id_example"; // String | The Id of a storage constituting space support for which default storage credentials should be returned. 

var spaceId = "spaceId_example"; // String | The Id of a space constituting space support for which default storage credentials should be returned. 


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

Parameters

Name Type Description Notes
id String The Id of a storage constituting space support for which default storage credentials should be returned.
spaceId String The Id of a space constituting space support for which default storage credentials should be returned.

Return type

PosixCompatibleCredentials

Authorization

api_key1, api_key2, basic

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

localFeedGetDisplayCredentials

PosixCompatibleCredentials localFeedGetDisplayCredentials(id, spaceId)

Lookup default display credentials in local feed

Returns default display credentials for the space support that are defined in local feed. These are POSIX credentials (UID & GID) which are returned in getattr response. They are used to present file owners in the result of e.g. `ls` or `stat` operation in Oneclient or when fetching file attributes via REST API. Returns an error if the storage has a different LUMA feed than `local`.

Example

var Onepanel = require('onepanel');
var defaultClient = Onepanel.ApiClient.instance;

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

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

// Configure HTTP basic authorization: basic
var basic = defaultClient.authentications['basic'];
basic.username = 'YOUR USERNAME';
basic.password = 'YOUR PASSWORD';

var apiInstance = new Onepanel.LUMADBLocalFeedApi();

var id = "id_example"; // String | The Id of a storage constituting space support for which default display credentials should be returned. 

var spaceId = "spaceId_example"; // String | The Id of a space constituting space support for which default display credentials should be returned. 


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

Parameters

Name Type Description Notes
id String The Id of a storage constituting space support for which default display credentials should be returned.
spaceId String The Id of a space constituting space support for which default display credentials should be returned.

Return type

PosixCompatibleCredentials

Authorization

api_key1, api_key2, basic

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

localFeedGetOnedataUserToCredentialsMapping

LumaStorageUser localFeedGetOnedataUserToCredentialsMapping(id, onedataUserId)

Lookup Onedata user to credentials mapping in local feed

Returns mapping of the Onedata user to user on the specific storage defined in local feed. Returns an error if the storage has a different LUMA feed than `local`.

Example

var Onepanel = require('onepanel');
var defaultClient = Onepanel.ApiClient.instance;

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

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

// Configure HTTP basic authorization: basic
var basic = defaultClient.authentications['basic'];
basic.username = 'YOUR USERNAME';
basic.password = 'YOUR PASSWORD';

var apiInstance = new Onepanel.LUMADBLocalFeedApi();

var id = "id_example"; // String | The Id of a storage for which user mapping should be returned. 

var onedataUserId = "onedataUserId_example"; // String | The Id of a user for which mapping should be returned. 


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

Parameters

Name Type Description Notes
id String The Id of a storage for which user mapping should be returned.
onedataUserId String The Id of a user for which mapping should be returned.

Return type

LumaStorageUser

Authorization

api_key1, api_key2, basic

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

localFeedGetUidToOnedataUserMapping

LumaOnedataUser localFeedGetUidToOnedataUserMapping(id, uid)

Lookup mapping of UID in local feed

Returns mapping of UID on the specific storage to Onedata user defined in local feed. Returns an error if the storage has a different LUMA feed than `local`. This endpoint is relevant only for POSIX compatible storages.

Example

var Onepanel = require('onepanel');
var defaultClient = Onepanel.ApiClient.instance;

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

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

// Configure HTTP basic authorization: basic
var basic = defaultClient.authentications['basic'];
basic.username = 'YOUR USERNAME';
basic.password = 'YOUR PASSWORD';

var apiInstance = new Onepanel.LUMADBLocalFeedApi();

var id = "id_example"; // String | The Id of a storage constituting space support for which onedata user mapping should be returned. 

var uid = 56; // Number | The UID of the user on the storage. 


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

Parameters

Name Type Description Notes
id String The Id of a storage constituting space support for which onedata user mapping should be returned.
uid Number The UID of the user on the storage.

Return type

LumaOnedataUser

Authorization

api_key1, api_key2, basic

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

localFeedModifyOnedataUserToCredentialsMapping

localFeedModifyOnedataUserToCredentialsMapping(id, onedataUserId, storageUser)

Update Onedata user to credentials mapping in local feed

Modifies mapping of the Onedata user to user on the specific storage in local feed. Returns an error if the storage has a different LUMA feed than `local`.

Example

var Onepanel = require('onepanel');
var defaultClient = Onepanel.ApiClient.instance;

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

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

// Configure HTTP basic authorization: basic
var basic = defaultClient.authentications['basic'];
basic.username = 'YOUR USERNAME';
basic.password = 'YOUR PASSWORD';

var apiInstance = new Onepanel.LUMADBLocalFeedApi();

var id = "id_example"; // String | The Id of a storage for which user mapping should be updated. 

var onedataUserId = "onedataUserId_example"; // String | The Id of a user for which mapping should be updated. 

var storageUser = new Onepanel.LumaStorageUser(); // LumaStorageUser | New user mapping 


var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
apiInstance.localFeedModifyOnedataUserToCredentialsMapping(id, onedataUserId, storageUser, callback);

Parameters

Name Type Description Notes
id String The Id of a storage for which user mapping should be updated.
onedataUserId String The Id of a user for which mapping should be updated.
storageUser LumaStorageUser New user mapping

Return type

null (empty response body)

Authorization

api_key1, api_key2, basic

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

localFeedRemoveAclGroupToOnedataGroupMapping

localFeedRemoveAclGroupToOnedataGroupMapping(id, groupname)

Remove mapping of ACL group from local feed

Removes mapping of ACL group on the specific storage to Onedata group from local feed. Returns an error if the storage has a different LUMA feed than `local`. This endpoint is relevant only for POSIX compatible storages.

Example

var Onepanel = require('onepanel');
var defaultClient = Onepanel.ApiClient.instance;

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

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

// Configure HTTP basic authorization: basic
var basic = defaultClient.authentications['basic'];
basic.username = 'YOUR USERNAME';
basic.password = 'YOUR PASSWORD';

var apiInstance = new Onepanel.LUMADBLocalFeedApi();

var id = "id_example"; // String | The Id of a storage constituting space support for which onedata group mapping should be removed. 

var groupname = 56; // Number | The ACL name of the group on the storage. 


var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
apiInstance.localFeedRemoveAclGroupToOnedataGroupMapping(id, groupname, callback);

Parameters

Name Type Description Notes
id String The Id of a storage constituting space support for which onedata group mapping should be removed.
groupname Number The ACL name of the group on the storage.

Return type

null (empty response body)

Authorization

api_key1, api_key2, basic

HTTP request headers

  • Content-Type: application/json
  • Accept: Not defined

localFeedRemoveAclUserToOnedataUserMapping

localFeedRemoveAclUserToOnedataUserMapping(id, username)

Remove mapping of ACL user from local feed

Removes mapping of ACL user on the specific storage to Onedata user from local feed. Returns an error if the storage has a different LUMA feed than `local`. This endpoint is relevant only for POSIX compatible storages.

Example

var Onepanel = require('onepanel');
var defaultClient = Onepanel.ApiClient.instance;

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

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

// Configure HTTP basic authorization: basic
var basic = defaultClient.authentications['basic'];
basic.username = 'YOUR USERNAME';
basic.password = 'YOUR PASSWORD';

var apiInstance = new Onepanel.LUMADBLocalFeedApi();

var id = "id_example"; // String | The Id of a storage constituting space support for which onedata user mapping should be removed. 

var username = 56; // Number | The ACL name of the user on the storage. 


var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
apiInstance.localFeedRemoveAclUserToOnedataUserMapping(id, username, callback);

Parameters

Name Type Description Notes
id String The Id of a storage constituting space support for which onedata user mapping should be removed.
username Number The ACL name of the user on the storage.

Return type

null (empty response body)

Authorization

api_key1, api_key2, basic

HTTP request headers

  • Content-Type: application/json
  • Accept: Not defined

localFeedRemoveDefaultPosixCredentials

localFeedRemoveDefaultPosixCredentials(id, spaceId)

Remove default posix credentials from local feed

Removes default storage credentials for the space supported by POSIX-compatible storage from local feed. Returns an error if the storage has a different LUMA feed than `local`. This endpoint is relevant only for POSIX compatible storages.

Example

var Onepanel = require('onepanel');
var defaultClient = Onepanel.ApiClient.instance;

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

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

// Configure HTTP basic authorization: basic
var basic = defaultClient.authentications['basic'];
basic.username = 'YOUR USERNAME';
basic.password = 'YOUR PASSWORD';

var apiInstance = new Onepanel.LUMADBLocalFeedApi();

var id = "id_example"; // String | The Id of a storage constituting space support for which default storage credentials should be removed. 

var spaceId = "spaceId_example"; // String | The Id of a space constituting space support for which default storage credentials should be removed. 


var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
apiInstance.localFeedRemoveDefaultPosixCredentials(id, spaceId, callback);

Parameters

Name Type Description Notes
id String The Id of a storage constituting space support for which default storage credentials should be removed.
spaceId String The Id of a space constituting space support for which default storage credentials should be removed.

Return type

null (empty response body)

Authorization

api_key1, api_key2, basic

HTTP request headers

  • Content-Type: application/json
  • Accept: Not defined

localFeedRemoveDisplayCredentials

localFeedRemoveDisplayCredentials(id, spaceId)

Remove default display credentials from local feed

Removes default display credentials for the space support from local feed. Returns an error if the storage has a different LUMA feed than `local`.

Example

var Onepanel = require('onepanel');
var defaultClient = Onepanel.ApiClient.instance;

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

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

// Configure HTTP basic authorization: basic
var basic = defaultClient.authentications['basic'];
basic.username = 'YOUR USERNAME';
basic.password = 'YOUR PASSWORD';

var apiInstance = new Onepanel.LUMADBLocalFeedApi();

var id = "id_example"; // String | The Id of a storage constituting space support for which default display credentials should be removed. 

var spaceId = "spaceId_example"; // String | The Id of a space constituting space support for which default display credentials should be removed. 


var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
apiInstance.localFeedRemoveDisplayCredentials(id, spaceId, callback);

Parameters

Name Type Description Notes
id String The Id of a storage constituting space support for which default display credentials should be removed.
spaceId String The Id of a space constituting space support for which default display credentials should be removed.

Return type

null (empty response body)

Authorization

api_key1, api_key2, basic

HTTP request headers

  • Content-Type: application/json
  • Accept: Not defined

localFeedRemoveOnedataUserToCredentialsMapping

localFeedRemoveOnedataUserToCredentialsMapping(id, onedataUserId)

Remove Onedata user to credentials mapping from local feed

Removes mapping of the Onedata user to user on the specific storage local feed. Returns an error if the storage has a different LUMA feed than `local`.

Example

var Onepanel = require('onepanel');
var defaultClient = Onepanel.ApiClient.instance;

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

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

// Configure HTTP basic authorization: basic
var basic = defaultClient.authentications['basic'];
basic.username = 'YOUR USERNAME';
basic.password = 'YOUR PASSWORD';

var apiInstance = new Onepanel.LUMADBLocalFeedApi();

var id = "id_example"; // String | The Id of a storage for which user mapping should be removed. 

var onedataUserId = "onedataUserId_example"; // String | The Id of a user for which mapping should be removed. 


var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
apiInstance.localFeedRemoveOnedataUserToCredentialsMapping(id, onedataUserId, callback);

Parameters

Name Type Description Notes
id String The Id of a storage for which user mapping should be removed.
onedataUserId String The Id of a user for which mapping should be removed.

Return type

null (empty response body)

Authorization

api_key1, api_key2, basic

HTTP request headers

  • Content-Type: application/json
  • Accept: Not defined

localFeedRemoveUidToOnedataUserMapping

localFeedRemoveUidToOnedataUserMapping(id, uid)

Remove mapping of UID from local feed

Removes mapping of UID on the specific storage to Onedata user from local feed. Returns an error if the storage has a different LUMA feed than `local`. This endpoint is relevant only for POSIX compatible storages.

Example

var Onepanel = require('onepanel');
var defaultClient = Onepanel.ApiClient.instance;

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

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

// Configure HTTP basic authorization: basic
var basic = defaultClient.authentications['basic'];
basic.username = 'YOUR USERNAME';
basic.password = 'YOUR PASSWORD';

var apiInstance = new Onepanel.LUMADBLocalFeedApi();

var id = "id_example"; // String | The Id of a storage constituting space support for which onedata user mapping should be removed. 

var uid = 56; // Number | The UID of the user on the storage. 


var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
apiInstance.localFeedRemoveUidToOnedataUserMapping(id, uid, callback);

Parameters

Name Type Description Notes
id String The Id of a storage constituting space support for which onedata user mapping should be removed.
uid Number The UID of the user on the storage.

Return type

null (empty response body)

Authorization

api_key1, api_key2, basic

HTTP request headers

  • Content-Type: application/json
  • Accept: Not defined

localFeedSetAclGroupToOnedataGroupMapping

localFeedSetAclGroupToOnedataGroupMapping(id, groupname, lumaOnedataGroup)

Insert mapping of ACL group into local feed

Sets mapping of ACL group on the specific storage to Onedata group in local feed. Returns an error if the storage has a different LUMA feed than `local`. This endpoint is relevant only for POSIX compatible storages.

Example

var Onepanel = require('onepanel');
var defaultClient = Onepanel.ApiClient.instance;

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

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

// Configure HTTP basic authorization: basic
var basic = defaultClient.authentications['basic'];
basic.username = 'YOUR USERNAME';
basic.password = 'YOUR PASSWORD';

var apiInstance = new Onepanel.LUMADBLocalFeedApi();

var id = "id_example"; // String | The Id of a storage constituting space support for which onedata group mapping should be set. 

var groupname = 56; // Number | The ACL name of the group on the storage. 

var lumaOnedataGroup = new Onepanel.LumaOnedataGroup(); // LumaOnedataGroup | Credentials identifying group in the Onedata system.


var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
apiInstance.localFeedSetAclGroupToOnedataGroupMapping(id, groupname, lumaOnedataGroup, callback);

Parameters

Name Type Description Notes
id String The Id of a storage constituting space support for which onedata group mapping should be set.
groupname Number The ACL name of the group on the storage.
lumaOnedataGroup LumaOnedataGroup Credentials identifying group in the Onedata system.

Return type

null (empty response body)

Authorization

api_key1, api_key2, basic

HTTP request headers

  • Content-Type: application/json
  • Accept: Not defined

localFeedSetAclUserToOnedataUserMapping

localFeedSetAclUserToOnedataUserMapping(id, username, lumaOnedataUser)

Insert mapping of ACL user into local feed

Sets mapping of ACL user on the specific storage to Onedata user in local feed. Returns an error if the storage has a different LUMA feed than `local`. This endpoint is relevant only for POSIX compatible storages.

Example

var Onepanel = require('onepanel');
var defaultClient = Onepanel.ApiClient.instance;

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

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

// Configure HTTP basic authorization: basic
var basic = defaultClient.authentications['basic'];
basic.username = 'YOUR USERNAME';
basic.password = 'YOUR PASSWORD';

var apiInstance = new Onepanel.LUMADBLocalFeedApi();

var id = "id_example"; // String | The Id of a storage constituting space support for for which onedata user mapping should be set. 

var username = 56; // Number | The ACL name of the user on the storage. 

var lumaOnedataUser = new Onepanel.LumaOnedataUser(); // LumaOnedataUser | Credentials identifying user in the Onedata system.


var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
apiInstance.localFeedSetAclUserToOnedataUserMapping(id, username, lumaOnedataUser, callback);

Parameters

Name Type Description Notes
id String The Id of a storage constituting space support for for which onedata user mapping should be set.
username Number The ACL name of the user on the storage.
lumaOnedataUser LumaOnedataUser Credentials identifying user in the Onedata system.

Return type

null (empty response body)

Authorization

api_key1, api_key2, basic

HTTP request headers

  • Content-Type: application/json
  • Accept: Not defined

localFeedSetDefaultPosixCredentials

localFeedSetDefaultPosixCredentials(id, spaceId, posixCredentials)

Insert default posix credentials into local feed

Sets default storage credentials for the space supported by POSIX-compatible storage in local feed. Returns an error if the storage has a different LUMA feed than `local`. This endpoint is relevant only for POSIX compatible storages.

Example

var Onepanel = require('onepanel');
var defaultClient = Onepanel.ApiClient.instance;

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

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

// Configure HTTP basic authorization: basic
var basic = defaultClient.authentications['basic'];
basic.username = 'YOUR USERNAME';
basic.password = 'YOUR PASSWORD';

var apiInstance = new Onepanel.LUMADBLocalFeedApi();

var id = "id_example"; // String | The Id of a storage constituting space support for which default storage credentials should be set. 

var spaceId = "spaceId_example"; // String | The Id of a space constituting space support for which default storage credentials should be set. 

var posixCredentials = new Onepanel.PosixCompatibleCredentials(); // PosixCompatibleCredentials | New default storage credentials for the space support. 


var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
apiInstance.localFeedSetDefaultPosixCredentials(id, spaceId, posixCredentials, callback);

Parameters

Name Type Description Notes
id String The Id of a storage constituting space support for which default storage credentials should be set.
spaceId String The Id of a space constituting space support for which default storage credentials should be set.
posixCredentials PosixCompatibleCredentials New default storage credentials for the space support.

Return type

null (empty response body)

Authorization

api_key1, api_key2, basic

HTTP request headers

  • Content-Type: application/json
  • Accept: Not defined

localFeedSetDisplayCredentials

localFeedSetDisplayCredentials(id, spaceId, displayCredentials)

Insert default display credentials into local feed

Sets default display credentials for the space support in local feed. Returns an error if the storage has a different LUMA feed than `local`.

Example

var Onepanel = require('onepanel');
var defaultClient = Onepanel.ApiClient.instance;

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

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

// Configure HTTP basic authorization: basic
var basic = defaultClient.authentications['basic'];
basic.username = 'YOUR USERNAME';
basic.password = 'YOUR PASSWORD';

var apiInstance = new Onepanel.LUMADBLocalFeedApi();

var id = "id_example"; // String | The Id of a storage constituting space support for which default display credentials should be set. 

var spaceId = "spaceId_example"; // String | The Id of a space constituting space support for which default display credentials should be set. 

var displayCredentials = new Onepanel.PosixCompatibleCredentials(); // PosixCompatibleCredentials | New default display credentials for the space support. 


var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
apiInstance.localFeedSetDisplayCredentials(id, spaceId, displayCredentials, callback);

Parameters

Name Type Description Notes
id String The Id of a storage constituting space support for which default display credentials should be set.
spaceId String The Id of a space constituting space support for which default display credentials should be set.
displayCredentials PosixCompatibleCredentials New default display credentials for the space support.

Return type

null (empty response body)

Authorization

api_key1, api_key2, basic

HTTP request headers

  • Content-Type: application/json
  • Accept: Not defined

localFeedSetUidToOnedataUserMapping

localFeedSetUidToOnedataUserMapping(id, uid, lumaOnedataUser)

Insert mapping of UID into local feed

Sets mapping of UID on the specific storage to Onedata user in local feed. Returns an error if the storage has a different LUMA feed than `local`. This endpoint is relevant only for POSIX compatible storages.

Example

var Onepanel = require('onepanel');
var defaultClient = Onepanel.ApiClient.instance;

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

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

// Configure HTTP basic authorization: basic
var basic = defaultClient.authentications['basic'];
basic.username = 'YOUR USERNAME';
basic.password = 'YOUR PASSWORD';

var apiInstance = new Onepanel.LUMADBLocalFeedApi();

var id = "id_example"; // String | The Id of a storage constituting space support for which onedata user mapping should be set. 

var uid = 56; // Number | The UID of the user on the storage. 

var lumaOnedataUser = new Onepanel.LumaOnedataUser(); // LumaOnedataUser | Credentials identifying user in the Onedata system.


var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
apiInstance.localFeedSetUidToOnedataUserMapping(id, uid, lumaOnedataUser, callback);

Parameters

Name Type Description Notes
id String The Id of a storage constituting space support for which onedata user mapping should be set.
uid Number The UID of the user on the storage.
lumaOnedataUser LumaOnedataUser Credentials identifying user in the Onedata system.

Return type

null (empty response body)

Authorization

api_key1, api_key2, basic

HTTP request headers

  • Content-Type: application/json
  • Accept: Not defined