Namespaces

A namespace is a logical unit of organization for data within a tenant. It is a collection of types, streams, and stream views. Each tenant may contain more than one namespace. Before you can put any data into CONNECT data services for a given tenant, a namespace must be created within the scope of that tenant. Namespace identifiers are unique within an account. Requirements for namespace Ids are the following:

• Must contain 100 characters or fewer
• Must only contain alphanumeric characters, underscores, dashes, spaces, and periods
• Must not contain two consecutive periods
• Must not start or end with a period
• Must not start with two consecutive underscores

In practice, namespaces may correspond to a specific set of infrastructure assets, but more commonly correspond to virtual partitions within a single set of assets. You can create one or more namespaces within a tenant. Each namespace is effectively an instance of SDS, within which you create types and streams, stream views, data views, and metadata. Creating and deleting namespaces must be done within CONNECT. See Create a folder and enable CONNECT data services.

Properties

For HTTP requests and responses, the Namespace object has the following properties and JSON-serialized body:

{
	"Id": "id",
	"Region": "region",
	"Self": "self",
	"Description": "description",
	"State": 0,
}

Region

When a namespace is created, all resources are created in the namespace's region. Resources created in this namespace (for example: types, streams, and stream views) will be created in the region of the namespace, and any data stored in the namespace will be stored in that region. Read and write operations at the namespace level and within a namespace utilize the base URL of the region in which the namespace resides. The Self property on each namespace provides the complete URL for all operations within that namespace.

Get All Namespaces

Returns all Namespaces owned by the specified Tenant that the caller has access to.

Request

GET api/v1/Tenants/{tenantId}/Namespaces

Parameters

[Required]
[FromRoute]
string tenantId

The identifier of the tenant to access.

Authorization

A Namespace can only be retrieved if the current principal has Read access.

Response

Get Namespace by Id

Returns a Namespace with the specified Id.

Request

GET api/v1/Tenants/{tenantId}/Namespaces/{namespaceId}

Parameters

[Required]
[FromRoute]
string tenantId

The identifier of the tenant to access.

[Required]
[FromRoute]
string namespaceId

The identifier of the Namespace to return.

Authorization

A Namespace can only be retrieved if the current principal has Read access.

Response

Update Namespace

Updates Namespace information: Description and TierId. The AccessControlList and Owner's Trustee can only be updated through their own routes.

Request

PUT api/v1/Tenants/{tenantId}/Namespaces/{namespaceId}

Parameters

[Required]
[FromRoute]
string tenantId

The identifier of the tenant to access.

[Required]
[FromRoute]
string namespaceId

The identifier of the Namespace to update.

[Required]
[FromBody]
Namespace newProperties

The new details to store for the Namespace.

Authorization

A Namespace can only be updated if the current principal has Write access.

Response

Get Namespace AccessControlList

Returns the AccessControlList that is used to authorize access to a Namespace.

Request

GET api/v1/Tenants/{tenantId}/Namespaces/{namespaceId}/accesscontrol

Parameters

[Required]
[FromRoute]
string tenantId

The identifier of the tenant to access.

[Required]
[FromRoute]
string namespaceId

The identifier of the Namespace to access.

Authorization

An AccessControlList can only be retrieved if the current principal has Read access.

Response

Set Namespace AccessControlList

Updates the AccessControlList that is used to authorize access to a Namespace.

Request

PUT api/v1/Tenants/{tenantId}/Namespaces/{namespaceId}/accesscontrol

Parameters

[Required]
[FromRoute]
string tenantId

The identifier of the tenant to access.

[Required]
[FromRoute]
string namespaceId

The identifier of the Namespace to access.

[Required]
[FromBody]
AccessControlList newAccessControlList

The updated AccessControlList for the Namespace.

Authorization

An AccessControlList can only be updated if the current principal has ManageAccessControl access.

Response

Get Namespace Owner

Returns the Owner's Trustee for a given Namespace.

Request

GET api/v1/Tenants/{tenantId}/Namespaces/{namespaceId}/owner

Parameters

[Required]
[FromRoute]
string tenantId

The identifier of the tenant to access.

[Required]
[FromRoute]
string namespaceId

The identifier of the Namespace to access.

Authorization

An Owner's Trustee can only be retrieved if the current principal has Read access.

Response

Set Namespace Owner

Changes the Owner's Trustee for a given Namespace.

Request

PUT api/v1/Tenants/{tenantId}/Namespaces/{namespaceId}/owner

Parameters

[Required]
[FromRoute]
string tenantId

The identifier of the tenant to access.

[Required]
[FromRoute]
string namespaceId

The identifier of the Namespace to access.

[Required]
[FromBody]
Trustee newOwner

The new Owner's Trustee of the Namespace.

Authorization

An Owner's Trustee can only be changed if the current principal has ManageAccessControl access.

Response