Onedata API Reference

REST API references for Onezone, Oneprovider, and Onepanel.

Version:

Onezone REST API Oneprovider REST API Onepanel REST API

Version:

Get LUMA DB configuration

GET /provider/storages/{id}/luma/config

Returns configuration of Local User Mapping database (LUMA DB) for the storage.

Path parameters

Parameter	Type & Description
id required	string The Id of a storage for which LUMA DB configuration should be returned.

Request Examples

Shell

onepanel-rest-cli -u onepanel:$PASSPHRASE lumaGetConfig id=$STORAGE_ID --host https://$HOST:9443

Responses

application/json

200

The LUMA configuration.

Property	Type & Description
lumaFeed string Type of feed for LUMA DB. Feed is a source of user/group mappings used to populate the LUMA DB. For more info please read: https://onedata.org/#/home/documentation/doc/administering_onedata/luma.html Enum: autolocalexternal
lumaFeedUrl string URL of external feed for LUMA DB. Relevant only if lumaFeed equals `external`.
lumaFeedApiKey string API key checked by external service used as feed for LUMA DB. Relevant only if lumaFeed equals `external`.

Example

application/json

{
  "lumaFeed": "external",
  "lumaFeedUrl": "http://example.external.luma.feed.com:8080",
  "lumaFeedApiKey": "ab9f4a57f303704ee75aa25808b898fd"
}

401

Unauthorized request.

403

Forbidden request.

404

Space does not exist or is not supported by the provider.

500

Internal server error.

Property

Type & 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.