Namespace:Update Namespace
Search (SHIFT+S)
ECS Management API
ECS Object Service API
ECS API Changes

Update Namespace

PUT /object/namespaces/namespace/{namespace}

Updates namespace details like replication group list, namespace admins and user mappings.

Replication group can be

  • Added to allowed or disallowed replication group list

  • Removed from allowed or disallowed replication group list

namespaceNamespace identifier whose details needs to be updated

Required Roles

Requires one of the following roles:

  • SYSTEM_ADMIN

  • NAMESPACE_ADMIN

Prerequisites

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

  • Namespace must exist

Request Payload

All parameters are required unless otherwise stated.

Field Description Type Notes
<namespace_update>
<default_data_services_vpool> Default replication group identifier when creating buckets URI
<vpools_added_to_allowed_vpools_list> List of replication group identifier which will be added in the allowed List for allowing namespace access URI 0-* Elements
<vpools_added_to_disallowed_vpools_list> List of replication group identifier which will be added in the disAllowed list for prohibiting namespace access URI 0-* Elements
<vpools_removed_from_allowed_vpools_list> List of replication group identifier which will be removed from allowed list URI 0-* Elements
<vpools_removed_from_disallowed_vpools_list> List of replication group identifier which will be removed from disAllowed list for removing their prohibition namespace access URI 0-* Elements
<namespace_admins> Comma separated list of namespace admins String
<user_mapping>     0-* Elements
<domain> A single-valued attribute indicating the user's IDP domain String Valid Values:
  •  Examples: "emc.com" or "netapp.com"
<attributes>
<attribute>     0-* Elements
<key> Lookup string for this key-value pair String
<value> Lookup result for this key-value pair String 0-* Elements
</attribute>      
</attributes>
<groups>
<group> String 0-* Elements
</groups>
</user_mapping>      
<default_bucket_block_size> Default bucket quota size. Long
<external_group_admins> List of groups from AD Server String
<is_encryption_enabled> Does request contain update of encryption enabled of namespace. If null then encryption update is not requested else it is. Boolean
<is_stale_allowed> isStaleAllowed flag of the namespace. Boolean
</namespace_update>

Response Body

Response indicating Success or Failure to update the namespace

Examples

Request
PUT https://192.168.0.0:4443/object/namespaces/namespace/urn:storageos:Project:6501579f-11ac-4c37-b3e8-f38d40b138d4: HTTP/1.1

Content-Type: application/xml
X-SDS-AUTH-TOKEN: <AUTH_TOKEN>

<namespace_update>
                <namespace>tenant3</namespace>
                <tenant>jt_tenant3</tenant>
                <namespace_admins>admin1,admin2,admin3</namespace_admins>
                <default_object_project>project4</default_object_project>
                <is_stale_allowed>true</is_stale_allowed>
                <!-- Mapping 1-->
                <user_mapping>
                                <domain>sanity.local</domain>
                                <attributes>
                                                <attribute>
                                                                <key>ou</key>
                                                                <value>123</value>
                                                </attribute>
                                                <attribute>
                                                                <key>dept</key>
                                                                <value>finance</value>
                                                </attribute>
                                </attributes>
                                <groups>
                                                <group>Domain Users</group>
                                                <group>group 2</group>
                                </groups>
                </user_mapping>
                <!-- Mapping 2-->
                <user_mapping>
                                <domain>sanity.local</domain>
                                <attributes>
                                                <attribute>
                                                                <key>dept</key>
                                                                <value>HR</value>
                                                </attribute>
                                </attributes>
                                <groups>
                                                <group>group3</group>
                                </groups>
                </user_mapping>
                <!-- Mapping 3-->
                <user_mapping>
                                <domain> sanity.local</domain>
                                <attributes>
                                                <attribute>
                                                                <key>secret_attribute</key>
                                                                <value>super_admin</value>
                                                </attribute>
                                </attributes>
                </user_mapping>
</namespace_update>
Response
HTTP/1.1 200 OK
Content-Type: application/xml
EMC ECS REST API v3.0.0.0
Notes: