Onedata API Reference

REST API references for Onezone, Oneprovider, and Onepanel.

Version:

Onezone REST API Oneprovider REST API Onepanel REST API

Version:

Get effective user of provider

GET /providers/{id}/effective_users/{uid}

Returns the details of an effective user of a specific provider. This operation requires any of the following authentication:

as the subject provider ({id}),
as user who has cluster_view privilege in the cluster corresponding to the subject provider,
as user who has oz_users_view admin privilege.

Example cURL requests

Get effective user of a provider

curl -u username:password -X GET  \
https://$HOST/api/v3/onezone/providers/$PROVIDER_ID/effective_users/$USER_ID

{
   "userId" : "f1c8b1a37aa7447b22eb65a742d40524",
   "fullName" : "John Doe",
   "username" : "jodoe",
   "emails" : [],
   "linkedAccounts" : []
}

Path parameters

Parameter	Type & Description
id required	string Provider Id.
uid required	string User Id.

Request Examples

Shell

onezone-rest-cli getEffectiveProviderUser id=1f290dd428ff09aab8ca014d24154a35 uid=051f1a51d80c664b0d9528d81ee56a93

Responses

application/json

200

The effective user details.

Property	Type & Description
userId string Unique user Id.
fullName string User's full name (given names + surname).
username string User's human-readable identifier, unique across the system. Makes it easier to identify the user and can be used for signing in with password.

Example

application/json

{
  "userId": "f1c8b1a37aa7447b22eb65a742d40524",
  "fullName": "Rudolf Lingens",
  "username": "r.lingens"
}

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