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 details

GET /user/effective_groups/{gid}

Returns information about a specific effective group to which the user has access.

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

Example cURL requests

Get user's effective group details

curl -u username:password -X GET \
https://$HOST/api/v3/onezone/user/effective_groups/$GROUP_ID

{
  "groupId": "59fec3bd894eef1cdae81623f477e370",
  "name": "admins",
  "type": "team"
}

Path parameters

Parameter	Type & Description
gid required	string Group Id.

Request Examples

Shell

onezone-rest-cli getUserEffectiveGroup gid=59fec3bd894eef1cdae81623f477e370

Responses

application/json

200

Returns the information about a specific effective group.

Property Type & Description

groupId

string

Unique group Id.

name

string

The name of the group.

type

string

The type of the group.

Enum:

organizationunitteamrole_holders

creator

object (Subject)

Object representing a subject in the system, can be perceived as client (actor) identity.

type string Type of the subject Enum: nobodyuseroneprovider
id string Id of the subject (`null` for nobody)

creationTime

integer (Timestamp)

Timestamp in seconds (UNIX epoch), e.g. 1563819329.

Example

application/json

{
  "groupId": "a4d3bc73aada63052310652d421609f1",
  "name": "Test group",
  "type": "team",
  "creator": {
    "type": "user",
    "id": "7434b256e71e1052e0d5e3e9da657ebf"
  },
  "creationTime": 1576152793
}

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