Onedata API Reference

REST API references for Onezone, Oneprovider, and Onepanel.

Version:

Onezone REST API Oneprovider REST API Onepanel REST API

Version:

Get summary of space membership requests

GET /user/space_membership_requests

Returns the summary of user's space membership requests.

This operation can be invoked on behalf of the current user only.

Example cURL requests

Get summary of space membership requests

curl -u admin:password -X GET \
https://$ZONE_HOST/api/v3/onezone/user/space_membership_requests

{
  "pending": {
    "715f5cf924cf8f69899a4ee8bbce8120": {
      "requestId": "585110fde9d1a52c93f8eb22c0614e47",
      "contactEmail": "user@example.com",
      "lastActivity": 1563819329
    },
    "6db7e3095d8aedf5c145ef576339b10d": {
      "requestId": "97216a666edd09945880a0785ad66a7b",
      "contactEmail": "user@example.com",
      "lastActivity": 1563819923
    }
  },
  "rejected": { 
    "ee7aa1c60642646b9a5d1962dcd02b89": {
      "requestId": "8467b1458989b8454a2faa8b5a45df7b",
      "contactEmail": "user@example.com",
      "lastActivity": 1563823164
    }
  }
}

Request Examples

Shell

onezone-rest-cli getSpaceMembershipRequests

Responses

application/json

200

Summary of user's space membership requests.

Property	Type & Description
pending object A map of space Ids and corresponding pending (not resolved) membership requests.
rejected object A map of space Ids and corresponding rejected membership requests.

Example

application/json

{
  "pending": {
    "715f5cf924cf8f69899a4ee8bbce8120": {
      "requestId": "585110fde9d1a52c93f8eb22c0614e47",
      "contactEmail": "user@example.com",
      "lastActivity": 1563819329
    },
    "6db7e3095d8aedf5c145ef576339b10d": {
      "requestId": "97216a666edd09945880a0785ad66a7b",
      "contactEmail": "user@example.com",
      "lastActivity": 1563819923
    }
  },
  "rejected": {
    "ee7aa1c60642646b9a5d1962dcd02b89": {
      "requestId": "8467b1458989b8454a2faa8b5a45df7b",
      "contactEmail": "user@example.com",
      "lastActivity": 1563823164
    }
  }
}

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