Onedata API Reference

REST API references for Onezone, Oneprovider, and Onepanel.

Version:

Onezone REST API Oneprovider REST API Onepanel REST API

Version:

Map IdP group to Onezone group

POST /provider/public/map_idp_group

Maps external IdP group Id into internal group Id in Onezone. The IdP must have group mapping enabled.

The group does not have to exist in Onezone or the IdP - this method merely transforms the Id using a deterministic procedure. It can be used to predict the group Id in Onezone before it is created.

This operation has public access.

Example cURL requests

Map IdP group to Onezone group

curl -H 'Content-type: application/json' \
-d '{"idp": "elixir", "groupId": "elixir:members"}' \
-X POST https://onezone.example.com/api/v3/onezone/provider/public/map_idp_group

{
  "groupId": "302da048de67e2ea05f0af1d0fe7c8a2"
}

Request body

application/json

Mapping parameters

Property	Type & Description
ipd string External IdP (identity provider).
groupId string GroupId in given IdP.

Request Examples

Shell

onezone-rest-cli mapIdpGroup ipd==elixir groupId==elixir:members

Responses

application/json

200

The group Id in external IdP.

Property	Type & Description
groupId string Internal group Id in Onezone.

Example

application/json

{
  "groupId": "302da048de67e2ea05f0af1d0fe7c8a2"
}

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