Onedata API Reference

REST API references for Onezone, Oneprovider, and Onepanel.

Onezone REST API Oneprovider REST API Onepanel REST API

Insert Onedata user to credentials mapping into local feed

POST /provider/storages/{id}/luma/local_feed/storage_access/all/onedata_user_to_credentials

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.

Path parameters

Parameter Type & Description
id required
string

The Id of a storage for which user mapping should be added.

Request body

New user mapping

PropertyType & Description
onedataUser
object (LumaOnedataUser)

Representation of Onedata user.

mappingScheme
discriminator string

Name of scheme used to represent user identity.

Name of scheme used to represent user identity.

storageUser
object (LumaStorageUser)

Credentials identifying user on the local storage resources.

storageCredentials required
object (LumaStorageCredentials)

Credentials that will be used to perform actions on the local storage resources in the context of the Onedata user.

type
discriminator string

Type of the storage. Must match the type of existing storage, needed only for OpenAPI polymorphism disambiguation.

Type of the storage. Must match the type of existing storage, needed only for OpenAPI polymorphism disambiguation.

Type of the storage. Must match the type of existing storage, needed only for OpenAPI polymorphism disambiguation.

Type of the storage. Must match the type of existing storage, needed only for OpenAPI polymorphism disambiguation.

Type of the storage. Must match the type of existing storage, needed only for OpenAPI polymorphism disambiguation.

Type of the storage. Must match the type of existing storage, needed only for OpenAPI polymorphism disambiguation.

Type of the storage. Must match the type of existing storage, needed only for OpenAPI polymorphism disambiguation.

Type of the storage. Must match the type of existing storage, needed only for OpenAPI polymorphism disambiguation.

Type of the storage. Must match the type of existing storage, needed only for OpenAPI polymorphism disambiguation.

Type of the storage. Must match the type of existing storage, needed only for OpenAPI polymorphism disambiguation.

displayUid
integer

This value will be used in the Oneclient to display it's owner UID if the corresponding user is owner of the file.

Request Examples

Shell
cat user_mapping.json | onepanel-rest-cli -u onepanel:$PASSPHRASE localFeedAddOnedataUserToCredentialsMapping id=$STORAGE_ID --host https://$HOST:9443

Responses

application/json
204

Onedata user mapping for given storage has been successfully added.

401

Unauthorized request.

403

Forbidden request.

404

Storage or user does not exist or LUMA feed is not local.

500

Internal server error.

PropertyType & Description
error
object

Object describing an error.

id required
string

String identifying the error type. Does not change between error instances.

description required
string

Human readable error description. May contain information specific to given error instance.

details
object

Details about the error instance. The object schema is specific to each error type.

Example

application/json
{
  "error": {
    "id": "badValueString",
    "details": {
      "key": "name"
    },
    "description": "Bad value: provided \"name\" must be a string."
  }
}
503

Services needed to fulfill this request are not running.