Type Alias Space

A space is a security context simplifying the management of access control by allowing users to control it on the containers instead of on the resources themselves.

type Space = {
    createdAt?: string;
    createdBy?: string;
    description?: string;
    id: string;
    links: { assignments: Link; self: Link };
    meta?: {
        actions: ActionName[];
        assignableRoles: RoleType[];
        roles: RoleType[];
    };
    name: string;
    ownerId?: string;
    tenantId: string;
    type?: "shared"
    | "managed"
    | "data";
    updatedAt?: string;
}
Index

Properties

createdAt? createdBy? description? id links meta? name ownerId? tenantId type? updatedAt?

Properties

createdAt?: string

The date and time when the space was created.

createdBy?: string

The ID of the user who created the space.

description?: string

The description of the space. Personal spaces do not have a description.

id: string

A unique identifier for the space, for example, 62716f4b39b865ece543cd45.

links: { assignments: Link; self: Link }
meta?: { actions: ActionName[]; assignableRoles: RoleType[]; roles: RoleType[] }

Information about the space settings.

Type Declaration

  • actions: ActionName[]

    The list of actions allowed by the current user in this space.

  • assignableRoles: RoleType[]

    The list of roles that could be assigned in this space.

  • roles: RoleType[]

    The list of roles assigned to the current user in this space.

name: string

The name of the space. Personal spaces do not have a name.

ownerId?: string

The ID for the space owner.

tenantId: string

The ID for the tenant, for example, xqGQ0k66vSR8f9G7J-vYtHZQkiYrCpct.

type?: "shared" | "managed" | "data"

The type of space such as shared, managed, and so on.

updatedAt?: string

The date and time when the space was updated.

Settings

Member Visibility

On This Page

Properties