Onedata API Reference

REST API references for Onezone, Oneprovider, and Onepanel.

Version:

Onezone REST API Oneprovider REST API Onepanel REST API

Version:

Get effective group's space membership intermediaries

GET /spaces/{id}/effective_groups/{gid}/membership

Returns the effective group's ({gid}) space membership intermediaries - entities from which the group inherits access to the space ({id}). Special keyword "self" in entity id indicates that the group ({gid}) has a direct access to the space ({id}).

This operation requires any of the following authentication:

as user who is an effective member of the group ({gid}),
as user who has space_view privilege in the space ({id}),
as provider that supports the space,
as user who has oz_spaces_view admin privilege.

Example cURL requests

Get effective group's space membership intermediaries

curl -u admin:password -X GET \
https://$HOST/api/v3/onezone/spaces/$SPACE_ID/effective_groups/$GROUP_ID/membership

{
  "intermediaries": [
    {"type": "group", "id": "95527367966a95639e93a88718450b36"},
    {"type": "group", "id": "2ef3de15fd49b3d6420f58428a6ad219"},
    {"type": "space", "id": "self"}
  ]
}

Path parameters

Parameter	Type & Description
id required	string Space Id.
gid required	string Group Id.

Request Examples

Shell

onezone-rest-cli getEffectiveGroupSpaceMembershipIntermediaries id=b752ceafabb662b4e5728b2ded25cdd1 gid=a5b469a2b0516b662a49da74d6d7d7bc

Responses

application/json

200

The list of membership intermediaries.

Property

Type & Description

intermediaries

array of objects

type string The type of the intermediary. Enum: groupspaceproviderhandle_servicehandlecluster
id string The id of the intermediary.

Example

application/json

{
  "intermediaries": [
    {
      "type": "group",
      "id": "ef228f31345699bbfa74b030517965a2"
    },
    {
      "type": "group",
      "id": "b55b907444dd00aab8cbe8dcb82681fd"
    },
    {
      "type": "space",
      "id": "self"
    }
  ]
}

400

Invalid request.

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."
  }
}

401

Authentication 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."
  }
}

403

Authorization 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."
  }
}

404

Resource not found.

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."
  }
}

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."
  }
}