Onedata API Reference

REST API references for Onezone, Oneprovider, and Onepanel.

Version:

Onezone REST API Oneprovider REST API Onepanel REST API

Version:

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

Property

Type & Description

onedataUser

object (LumaOnedataUser)

Representation of Onedata user.

mappingScheme

discriminator string

Name of scheme used to represent user identity.

onedataUserId

string

The id of user in Onedata system.

idp

string

The id of an external identity provider.

subjectId

string

The id of the user understood by the external identity provider.

onedataUserId

string

The id of user in Onedata system.

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 be given explicitly and must match the actual type of subject storage - this redundancy is needed due to limitations of OpenAPI polymorphism.

uid

integer

User identifier.

gid

integer

Group identifier.

accessKey

string

The access key to the S3 storage.

secretKey

string

The secret key to the S3 storage.

username

string

The username of the Ceph cluster user. In case of configuring storage, this field must be equal to name of the Ceph cluster admin.

key

string

The key to access the Ceph cluster. In case of configuring storage, the key must be the key of admin user passed in username.

username

string

The username of the Ceph cluster administrator.

key

string

The admin key to access the Ceph cluster.

username

string

The Keystone authentication username.

password

string

The Keystone authentication password.

projectName

string

The Keystone project name.

userDomainName

string

The Keystone user domain name.

projectDomainName

string

The Keystone project domain name.

uid

integer

User identifier.

gid

integer

Group identifier.

uid

integer

User identifier.

gid

integer

Group identifier.

credentialsType

string

Determines the types of credentials provided in the credentials field.

Enum:

none basic token oauth2

credentials

string

The credentials to authenticate with the WebDAV server. basic credentials should be provided in the form username:password, for token just the token. In case of oauth2, this field should contain the username for the WebDAV, while the token will be obtained and refreshed automatically in the background. For none this field is ignored.

oauth2IdP

string

In case oauth2 credential type is selected and Onezone is configured with support for multiple external IdP's, this field must contain the name of the IdP which authenticates requests to the WebDAV endpoint. If Onezone has only one external IdP, it will be selected automatically.

onedataAccessToken

string

When registering storage with feed of LUMA DB set toauto and with oauth2 external IdP, this field must contain a valid Onedata access token of the user on whose behalf the WebDAV storage will be accessed by all users with access to any space supported by this storage.

credentialsType

string

Determines the types of credentials provided in the credentials field.

Enum:

none pwd

credentials

string

The credentials to authenticate with the XRootD server. For pwd credentials type, this field should contain simply user and password, e.g. admin:password. For none this field is ignored.

uid

integer

User identifier.

gid

integer

Group identifier.

credentialsType

string

Determines the types of credentials provided in the credentials field.

Enum:

none basic token oauth2

credentials

string

The credentials to authenticate with the HTTP server. basic credentials should be provided in the form username:password, for token just the token. In case of oauth2, this field should contain the username for the HTTP, while the token will be obtained and refreshed automatically in the background. For none this field is ignored.

oauth2IdP

string

In case oauth2 credential type is selected and Onezone is configured with support for multiple external IdP's, this field must contain the name of the IdP which authenticates requests to the HTTP endpoint. If Onezone has only one external IdP, it will be selected automatically.

onedataAccessToken

string

When registering storage with feed of LUMA DB set toauto and with oauth2 external IdP, this field must contain a valid Onedata access token of the user on whose behalf the HTTP storage will be accessed by all users with access to any space supported by this storage.

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://$OP_PANEL_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.

Property

Type & Description

error

object (ErrorDetails)

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.