Cloud Enterprise Object Storage REST API

Search (SHIFT+S)




Set Profile Mappings

POST /object/transformation/{transformationId}/profile/mapping

Sets a ProfileMapping for one or several ECS user profiles to the corresponding profiles from a Centera legacy storage system.

A ProfileMapping defines a mapping between a pair of data instances defined as a legacy storage bucket and legacy storage user mapped to a pair of data instances defined as an ECS bucket and an ECS user. ECS needs this mapping to redirect requests to a legacy storage bucket using correct legacy storage user credentials when some ECS bucket is accessed by an ECS user.

Both pairs are correlated using the source_id identifier. For instance, if user A has access to two buckets B and C in the Legacy Storage, then ECS should assign two source_id identifiers: sourceProfile1 and sourceProfile2, one for each legacy storage bucket. Set two ECS Profile Mapping entries, one for each legacy storage bucket, as in this example:

 {
     "source_id": "centeraPool1/centeraProfile1",
     "target_user": "ecs_user_a",
     "target_bucket": "ecs_bucket_b",
     "target_namespace": "ecs_namespace"
     },
     {
     "source_id": "centeraPool2/centeraProfile2",
     "target_user": "ecs_user_a",
     "target_bucket": "ecs_bucket_c",
     "target_namespace": "ecs_namespace"
     }
 

NOTE: The Target namespace ("target_namespace": "ecs_namespace") should be the namespace created by this transformation. If you specify some other existing namespace irrespective of the target namespace provided in your request body, ECS creates the pool/profile in the namespace created by this transformation.

Passed ProfileMapping entries override any previously set or auto-calculated ones for the same source_id identifier. Overriding an auto-calculated Profile Mapping with the same one effectively clears any existing conflicts. Use this call to resolve conflicting Profile Mappings by setting them manually.

transformationIdTransformation ID of transformation.

Required Roles

  • SYSTEM_ADMIN


Prerequisites

The following conditions must be met in order to call this operation.

  • Transformation must exist.


Request Payload

All parameters are required unless otherwise stated.

Field Description Type Notes
profile_mappings
mappings     0-* Elements
source_id Source ID of transformation mapping String
target_user Target user for profile mapping String
target_bucket Target bucket for profile mapping String
target_namespace Target namespace for profile mapping String
encryption_enabled Encryption for target bucket Boolean

Response Body

Response contains status of the operation.


JSON Example

Request
The curl example stores arguments in the file req_body.tmp:
{
"mappings": [
        {
        "source_id":        "buck_1/user_n1",
        "target_user":      "ecs_user_n1",
        "target_bucket":    "ecs_buck_1",
        "target_namespace": "centera_7b4985d2-1dd2-11b2-9ac4-9b1603e01545"
        }
    ]
}

The curl command to accomplish this is:
curl -s -k -X POST -H Content-Type:application/json -H X-SDS-AUTH-TOKEN:$TOKEN -H ACCEPT:application/json -d @req_body.tmp https://10.247.200.192:4443/object/transformation/urn:Transformation:Centera:7b4985d2-1dd2-11b2-9ac4-9b1603e01545/profile/mapping
Response