Data model
All data is stored through the persistence layer in the tables (or collections) below. Names get a prefix from the DYNAMODB_TABLE_PREFIX or MONGODB_COLLECTION_PREFIX environment variable. Tables with an expiry attribute remove old records automatically.
Table | ID field | Expires | Purpose |
|---|---|---|---|
permissionResources | permissionResourceID | No | Permission resources and their options |
roles | roleID | No | Roles |
auditLogs | auditLogID | expiresAt | Audit log entries |
configurations | configurationID | No | App and Sandbox Tooling settings |
imsCache | cacheKey | expiresAt | Cached IMS users and groups |
sandboxCleanup | sandboxCleanupID | No | One record per cleanup |
dashboards | dashboardID | expiresAt | TODO(user) |
labs | labId | No | TODO(user) |
labModules | moduleId | No | TODO(user) |
labSalesPlays | salesPlayId | No | TODO(user) |
labContributors | contributorId | No | TODO(user) |
labBrands | brandId | No | TODO(user) |
labSolutions | solutionId | No | TODO(user) |
labUserGroupJobs | jobID | expiresAt | TODO(user) |
Most tables can be filtered by org and appNamespace. The value * in those fields matches every org or namespace. sandboxCleanup can also be filtered by status.
{
"permissionResourceID": "STRING - Unique ID of the permission resource (UUID v4). Partition key",
"appNamespace": "STRING - App instance the record belongs to, formatted <orgId>__<runtime namespace>. '*' for global resources",
"org": "STRING - IMS org ID the resource applies to. '*' for all orgs",
"name": "STRING - Internal name, unique. Used in code to check permissions, for example 'SandboxTooling'",
"label": "STRING - Display name, unique, shown in the Permissions page",
"description": "STRING - What the resource is for",
"options": [
{
"id": "STRING - Unique ID of the option (UUID v4). Roles store this ID",
"label": "STRING - Display name of the option",
"name": "STRING - Internal name of the option, used in code, for example 'cleanup-sandbox-view'"
}
],
"audit": {
"createdAt": "STRING - ISO 8601 timestamp of creation",
"createdBy": {
"email": "STRING - Email of the creator. 'Unknown' if not available",
"name": "STRING - Name of the creator. 'Unknown' if not available",
"userId": "STRING - IMS user ID of the creator. 'Unknown' if not available"
},
"updatedAt": "STRING - ISO 8601 timestamp of the last update",
"updatedBy": {
"email": "STRING - Email of the last editor",
"name": "STRING - Name of the last editor",
"userId": "STRING - IMS user ID of the last editor"
}
}
}{
"roleID": "STRING - Unique ID of the role (UUID v4). Partition key",
"appNamespace": "STRING - App instance the record belongs to, formatted <orgId>__<runtime namespace>",
"org": "STRING - IMS org ID the role belongs to",
"label": "STRING - Display name of the role",
"description": "STRING - What the role is for",
"permissions": {
"<permissionResourceID>": [
"STRING - ID of an option of that permission resource granted by this role"
]
},
"users": [
{
"id": "STRING - IMS user ID",
"name": "STRING - First and last name",
"email": "STRING - Email address"
}
],
"userGroups": [
{
"id": "STRING or NUMBER - IMS user group ID",
"name": "STRING - Name of the user group",
"userCount": "NUMBER - Number of users in the group when it was added"
}
],
"audit": {
"createdAt": "STRING - ISO 8601 timestamp of creation",
"createdBy": {
"email": "STRING - Email of the creator. 'Unknown' if not available",
"name": "STRING - Name of the creator. 'Unknown' if not available",
"userId": "STRING - IMS user ID of the creator. 'Unknown' if not available"
},
"updatedAt": "STRING - ISO 8601 timestamp of the last update",
"updatedBy": {
"email": "STRING - Email of the last editor",
"name": "STRING - Name of the last editor",
"userId": "STRING - IMS user ID of the last editor"
}
}
}{
"auditLogID": "STRING - Unique ID of the entry (UUID v4). Partition key",
"appNamespace": "STRING - App instance the record belongs to, formatted <orgId>__<runtime namespace>",
"timestamp": "NUMBER - Epoch seconds when the action happened",
"expiresAt": "NUMBER - Epoch seconds when the record expires (TTL attribute). timestamp plus auditLogTTL days. Default 90 days",
"assetName": "STRING - Name of the item that was changed",
"category": "STRING - Type of item, for example 'Role', 'Permission Resource', 'User', 'Sandbox Cleanup'",
"action": "STRING - What happened, for example 'Create', 'Update', 'Delete', 'Execute', 'Finished'",
"status": "STRING - Result of the action. One of Success, Failure",
"user": {
"email": "STRING - Email of the user who did it",
"name": "STRING - Name of the user who did it",
"userId": "STRING - IMS user ID of the user who did it"
},
"context": {
"message": "STRING - Human-readable description of what happened",
"data": "OBJECT or NULL - Extra details about the action. Free-form"
}
}{
"configurationID": "STRING - Unique ID, formatted <orgId>__<runtime namespace>. Partition key",
"appNamespace": "STRING - App instance the record belongs to, same value as configurationID",
"org": "STRING - IMS org ID",
"settings": {
"App": {
"database": "STRING - Label of the database in use. Default DynamoDB",
"databaseInitialized": "BOOLEAN - True once the database initialization has completed. Default false",
"auditLogEnabled": "BOOLEAN - Whether administrative actions are written to the audit log. Default true",
"auditLogTTL": "NUMBER - Days an audit log entry is kept. Default 90"
},
"sandboxTooling": {
"cleanupHistoryTTL": "NUMBER - Days a finished cleanup record is kept, 1 to 365. Default 365",
"allowManualHistoryDeletion": "BOOLEAN - Whether people may delete history records older than the TTL. Default true",
"sandboxFilter": "STRING - Which sandboxes people can pick. Default userPermission. One of all, userPermission",
"sandboxBlacklist": [
{
"name": "STRING - Technical name of a sandbox that can't be cleaned",
"title": "STRING - Display name of that sandbox. The sandbox object as returned by the sandbox list may hold more fields"
}
],
"cleanupMethods": [
{
"id": "STRING - Method ID. One of userGroup, age, keyword, manual",
"label": "STRING - Display name of the method"
}
],
"cleanupMethod": "STRING - Method that is pre-selected. One of userGroup, age, keyword, manual",
"cleanupUserGroups": [
"STRING - ID of a user group people may choose in the User group(s) method"
],
"cleanupDefaultUserGroups": [
"STRING - ID of a user group that is pre-selected. Must also be in cleanupUserGroups"
],
"cleanupAgeValue": "NUMBER - Default age for the Age method. Default 1",
"cleanupAgeUnit": "STRING - Unit of the default age. Default months. One of days, weeks, months, years",
"cleanupKeywords": [
"STRING - Keyword that is pre-filled in the Keyword(s) method. Default is an empty list"
]
},
"labTooling": {
"entraId": {
"tenantId": "STRING - Microsoft Entra ID tenant ID",
"clientId": "STRING - Client ID of the Entra ID app registration",
"clientSecretId": "STRING - ID of the client secret",
"clientSecret": "STRING - Value of the client secret. Sensitive",
"graphBaseUrl": "STRING - Base URL of the Microsoft Graph API",
"clientSecretDisplayName": "STRING - Display name of the client secret, filled by Test Connection",
"clientSecretExpiry": "STRING - ISO 8601 expiry of the client secret, filled by Test Connection",
"lastTestedAt": "STRING - ISO 8601 timestamp of the last successful Test Connection",
"adobeResourceId": "STRING - ID of the Adobe app in Entra ID, filled by Test Connection",
"adobeResourceName": "STRING - Name of the Adobe app in Entra ID",
"adobeRoleId": "STRING - ID of the app role in Entra ID",
"domain": "STRING - Domain used for lab users"
},
"userGroup": {
"passwordRequirements": {
"minLength": "NUMBER - Minimum password length. Default 8",
"maxLength": "NUMBER - Maximum password length. Default 16",
"requireNumber": "BOOLEAN - Password needs a number. Default true",
"requireSpecialChar": "BOOLEAN - Password needs a special character. Default true",
"requireUppercase": "BOOLEAN - Password needs an uppercase letter. Default true",
"requireLowercase": "BOOLEAN - Password needs a lowercase letter. Default true"
},
"defaultDisabledPassword": "STRING - Password given to disabled lab users. Sensitive",
"defaultUserDisplayName": "STRING - Display name given to lab users. Default Lab user"
}
}
},
"audit": {
"createdAt": "STRING - ISO 8601 timestamp of creation",
"createdBy": {
"email": "STRING - Email of the creator. 'Unknown' if not available",
"name": "STRING - Name of the creator. 'Unknown' if not available",
"userId": "STRING - IMS user ID of the creator. 'Unknown' if not available"
},
"updatedAt": "STRING - ISO 8601 timestamp of the last update",
"updatedBy": {
"email": "STRING - Email of the last editor",
"name": "STRING - Name of the last editor",
"userId": "STRING - IMS user ID of the last editor"
}
}
}{
"cacheKey": "STRING - Cache key, formatted ims_<type>_<orgId>_<page>_<group identifier or 'none'>. Partition key",
"orgId": "STRING - IMS org ID the response belongs to",
"type": "STRING - What was cached. Default users. One of groups, groupUsers, users",
"data": {
"groups": [
"OBJECT - IMS user group. Present when type is groups"
],
"users": [
"OBJECT - IMS user. Present when type is users or groupUsers"
],
"lastPage": "BOOLEAN - True if this was the last page of results"
},
"createdAt": "NUMBER - Epoch milliseconds when the response was cached (a date in MongoDB)",
"expiresAt": "NUMBER - Epoch milliseconds when the cache entry stops being valid, createdAt plus 30 minutes (TTL attribute, a date in MongoDB)"
}{
"sandboxCleanupID": "STRING - Unique ID of the cleanup (UUID v4). Partition key",
"appNamespace": "STRING - App instance the record belongs to, formatted <orgId>__<runtime namespace>",
"org": "STRING - IMS org ID",
"configuration": {
"sandbox": "STRING - Technical name of the sandbox",
"sandboxLabel": "STRING - Display name of the sandbox",
"target": "ARRAY of STRING - Apps included. Values rtcdp, ajo, cja, data",
"reason": "STRING - Reason entered by the user",
"cleanupMethod": "STRING - Method used. One of userGroup, age, keyword, manual",
"userGroups": [
{
"id": "STRING - ID of a user group whose items are kept. Only for the userGroup method",
"name": "STRING - Name of that user group"
}
],
"age": {
"value": "NUMBER - Age cutoff. Only for the age method",
"unit": "STRING - Unit of the cutoff. One of day, days, week, weeks, month, months, year, years"
},
"keywords": [
"STRING - Keyword to match in item names. Only for the keyword method"
]
},
"objectsToRemove": [
{
"id": "STRING - ID of the object to remove",
"name": "STRING - Name of the object",
"target": "STRING - App the object belongs to. One of rtcdp, ajo, cja, data",
"objectType": "STRING - Category of the object, for example journeys, audiences, schemas"
}
],
"process": {
"status": "STRING - Cleanup status. One of In progress (shown as Preparing), Executing, Completed",
"currentStep": "NUMBER - Wizard step. 2 Curate, 4 Execute, 5 Recap",
"currentStepLabel": "STRING - Name of the wizard step",
"currentCategoryKey": "STRING - Category being removed right now. Only while executing",
"startDate": "STRING - ISO 8601 timestamp when the cleanup started",
"endDate": "STRING - ISO 8601 timestamp when the cleanup finished. Empty until then",
"errors": "NUMBER - Number of items that could not be removed. Set when completed"
},
"results": {
"removedObjects": [
{
"category": "STRING - Display name of the category",
"createdBy": {
"id": "STRING - Creator of the item as known by the platform",
"label": "STRING - Display name of the creator"
},
"name": "STRING - Name of the removed item"
}
],
"errors": [
{
"category": "STRING - Display name of the category",
"id": "STRING - ID of the item that could not be removed",
"error": {
"code": "STRING - Error code or name",
"message": "STRING - Error message"
}
}
]
},
"expiresAt": "NUMBER - Epoch seconds when the record is deleted. 24 hours after creation while preparing, then now plus cleanupHistoryTTL days (default 365) once execution starts",
"audit": {
"createdAt": "STRING - ISO 8601 timestamp of creation",
"createdBy": {
"email": "STRING - Email of the creator. 'Unknown' if not available",
"name": "STRING - Name of the creator. 'Unknown' if not available",
"userId": "STRING - IMS user ID of the creator. 'Unknown' if not available"
},
"updatedAt": "STRING - ISO 8601 timestamp of the last update",
"updatedBy": {
"email": "STRING - Email of the last editor",
"name": "STRING - Name of the last editor",
"userId": "STRING - IMS user ID of the last editor"
}
}
}{
"dashboardID": "STRING - Unique ID, formatted <orgId>__<runtime namespace>__<dashboard name>. Partition key",
"appNamespace": "STRING - App instance the record belongs to",
"lastRefreshed": "NUMBER - Epoch seconds of the last refresh",
"expiresAt": "NUMBER - Epoch seconds when the record expires (TTL attribute). lastRefreshed plus 4 hours",
"totalRoles": "NUMBER - Number of roles",
"totalUsers": "NUMBER - Number of users with a role, counting users in assigned user groups",
"topUsers": [
{
"name": "STRING - Name of the user",
"lastTimestamp": "NUMBER - Timestamp of the user's latest audit log entry",
"numberOfLogs": "NUMBER - Number of audit log entries by the user. Top 3 users"
}
],
"recentUsers": [
{
"name": "STRING - Name of the user",
"lastTimestamp": "NUMBER - Timestamp of the user's latest audit log entry",
"numberOfLogs": "NUMBER - Number of audit log entries by the user. 3 most recent users"
}
],
"topFeatures": [
{
"category": "STRING - Audit log category",
"numberOfLogs": "NUMBER - Number of audit log entries in that category"
}
]
}{
"labId": "STRING - Unique ID of the lab (UUID v4). Partition key",
"appNamespace": "STRING - App instance the record belongs to",
"config": {
"label": "STRING - Name of the lab",
"type": "STRING - Lab type. One of CSC, CXO, OneAdobe",
"requestType": "STRING - Kind of request. One of hol, bootcamp",
"projectStartDate": "STRING - Project start date as text (date object converted to a string, not guaranteed ISO 8601)",
"team": [
{
"role": "STRING - Role in the lab. One of projectLead, teamMember, presenter, viewer. One project lead",
"email": "STRING - Email address",
"name": "STRING - Name"
}
]
},
"process": {
"status": "STRING - Lab status. Default initiated",
"currentStage": "NUMBER - Current stage of the lab workflow. Default 1",
"currentStageLabel": "STRING - Name of the current stage. Default Configure"
},
"audit": {
"createdAt": "STRING - ISO 8601 timestamp of creation",
"createdBy": {
"email": "STRING - Email of the creator. 'Unknown' if not available",
"name": "STRING - Name of the creator. 'Unknown' if not available",
"userId": "STRING - IMS user ID of the creator. 'Unknown' if not available"
},
"updatedAt": "STRING - ISO 8601 timestamp of the last update",
"updatedBy": {
"email": "STRING - Email of the last editor",
"name": "STRING - Name of the last editor",
"userId": "STRING - IMS user ID of the last editor"
}
}
}{
"moduleId": "STRING - Unique ID (UUID v4). Partition key",
"appNamespace": "STRING - App instance the record belongs to",
"internalName": "STRING - Internal name, unique",
"type": "STRING - Required. One of CSC, CXO, OneAdobe",
"label": "STRING - Display name",
"shortDescription": "STRING - Short description. Optional",
"longDescription": "STRING - Long description. Optional",
"image": "STRING - Image URL. Optional",
"presentationSection": "STRING - Name of the section in a sales play presentation. Optional",
"presentationUrl": "STRING - URL of the presentation. Optional",
"duration": "NUMBER - Minutes when run as hands-on, 0 to 999. Optional",
"durationDemo": "NUMBER - Minutes when run as demo, 0 to 999. Optional",
"skippable": "BOOLEAN - Whether the module can be skipped. Default false",
"deprecated": "BOOLEAN - Whether the module is deprecated. Default false",
"features": [
{
"solutionInternalName": "STRING - internalName of a labSolutions record",
"internalName": "STRING - internalName of one of that solution's features"
}
],
"brands": [
{
"internalName": "STRING - internalName of a labBrands record",
"shortStory": "STRING - Short story for that brand",
"longStory": "STRING - Long story for that brand"
}
],
"audit": {
"createdAt": "STRING - ISO 8601 timestamp of creation",
"createdBy": {
"email": "STRING - Email of the creator. 'Unknown' if not available",
"name": "STRING - Name of the creator. 'Unknown' if not available",
"userId": "STRING - IMS user ID of the creator. 'Unknown' if not available"
},
"updatedAt": "STRING - ISO 8601 timestamp of the last update",
"updatedBy": {
"email": "STRING - Email of the last editor",
"name": "STRING - Name of the last editor",
"userId": "STRING - IMS user ID of the last editor"
}
}
}{
"salesPlayId": "STRING - Unique ID (UUID v4). Partition key",
"appNamespace": "STRING - App instance the record belongs to",
"internalName": "STRING - Internal name, unique",
"type": "STRING - Required. One of CSC, CXO, OneAdobe",
"label": "STRING - Display name",
"startYear": "NUMBER - First year the sales play is used. Required",
"endYear": "NUMBER - Last year the sales play is used. Empty means still active. Optional",
"active": "BOOLEAN - Whether the sales play is active. Default true",
"documentationUrl": "STRING - URL of the documentation. Optional",
"presentationUrl": "STRING - URL of the presentation. Optional",
"modules": [
"STRING - internalName of a labModules record"
],
"audit": {
"createdAt": "STRING - ISO 8601 timestamp of creation",
"createdBy": {
"email": "STRING - Email of the creator. 'Unknown' if not available",
"name": "STRING - Name of the creator. 'Unknown' if not available",
"userId": "STRING - IMS user ID of the creator. 'Unknown' if not available"
},
"updatedAt": "STRING - ISO 8601 timestamp of the last update",
"updatedBy": {
"email": "STRING - Email of the last editor",
"name": "STRING - Name of the last editor",
"userId": "STRING - IMS user ID of the last editor"
}
}
}{
"contributorId": "STRING - Unique ID (UUID v4). Partition key",
"appNamespace": "STRING - App instance the record belongs to",
"email": "STRING - Email address, unique. Required",
"name": "STRING - Full name. Required",
"jobTitle": "STRING - Job title. Optional",
"imageUrl": "STRING - Profile image URL. Optional",
"region": "STRING - Region. Optional. One of AMER, EMEA, APAC",
"country": "STRING - Country. Optional",
"city": "STRING - City. Optional",
"timezone": "STRING - Time zone ID. Optional",
"audit": {
"createdAt": "STRING - ISO 8601 timestamp of creation",
"createdBy": {
"email": "STRING - Email of the creator. 'Unknown' if not available",
"name": "STRING - Name of the creator. 'Unknown' if not available",
"userId": "STRING - IMS user ID of the creator. 'Unknown' if not available"
},
"updatedAt": "STRING - ISO 8601 timestamp of the last update",
"updatedBy": {
"email": "STRING - Email of the last editor",
"name": "STRING - Name of the last editor",
"userId": "STRING - IMS user ID of the last editor"
}
}
}{
"brandId": "STRING - Unique ID (UUID v4). Partition key",
"appNamespace": "STRING - App instance the record belongs to",
"internalName": "STRING - Internal name, unique. Required",
"name": "STRING - Display name. Required",
"industry": "STRING - Industry. Optional",
"businessType": "STRING - Business type, 20 characters at most. Optional",
"logoUrl": "STRING - Logo URL. Optional",
"bannerImageUrl": "STRING - Banner image URL. Optional",
"dsnDocUrl": "STRING - URL of the brand's DSN document. Optional",
"brandPackUrl": "STRING - URL of the brand pack. Optional",
"audit": {
"createdAt": "STRING - ISO 8601 timestamp of creation",
"createdBy": {
"email": "STRING - Email of the creator. 'Unknown' if not available",
"name": "STRING - Name of the creator. 'Unknown' if not available",
"userId": "STRING - IMS user ID of the creator. 'Unknown' if not available"
},
"updatedAt": "STRING - ISO 8601 timestamp of the last update",
"updatedBy": {
"email": "STRING - Email of the last editor",
"name": "STRING - Name of the last editor",
"userId": "STRING - IMS user ID of the last editor"
}
}
}{
"solutionId": "STRING - Unique ID (UUID v4). Partition key",
"appNamespace": "STRING - App instance the record belongs to",
"internalName": "STRING - Internal name, unique. Required",
"name": "STRING - Display name. Required",
"type": "STRING - Required. One of CSC, CXO, OneAdobe",
"abbreviation": "STRING - Short name. Optional",
"logoUrl": "STRING - Logo URL. Optional",
"features": [
{
"internalName": "STRING - Internal name, unique within the solution",
"name": "STRING - Display name. Required",
"abbreviation": "STRING - Short name. Default empty",
"description": "STRING - Description. Default empty",
"logoUrl": "STRING - Logo URL. Default empty"
}
],
"audit": {
"createdAt": "STRING - ISO 8601 timestamp of creation",
"createdBy": {
"email": "STRING - Email of the creator. 'Unknown' if not available",
"name": "STRING - Name of the creator. 'Unknown' if not available",
"userId": "STRING - IMS user ID of the creator. 'Unknown' if not available"
},
"updatedAt": "STRING - ISO 8601 timestamp of the last update",
"updatedBy": {
"email": "STRING - Email of the last editor",
"name": "STRING - Name of the last editor",
"userId": "STRING - IMS user ID of the last editor"
}
}
}{
"jobID": "STRING - Unique ID of the job. Partition key",
"appNamespace": "STRING - App instance the record belongs to",
"org": "STRING - IMS org ID",
"groupId": "STRING - ID of the lab user group",
"groupDisplayName": "STRING - Name of the lab user group",
"actionType": "STRING - What the job does. One of enableDisable, changeCount, personalise, resetDisplay, addGroup",
"overallStatus": "STRING - Job status. One of in-progress, completed, completed-with-errors",
"batches": [
{
"batchIndex": "NUMBER - Position of the batch",
"userIds": [
"STRING - ID of a user in the batch. Batches hold 5 users"
],
"provisioningJobId": "STRING - ID of the provisioning job at the provider",
"status": "STRING - Batch status. One of submitted, polling, succeeded, failed",
"attempts": "NUMBER - Number of attempts",
"lastError": "STRING - Last error message",
"submittedAt": "STRING - When the batch was submitted. Format not specified in the plan",
"resolvedAt": "STRING - When the batch was resolved. Format not specified in the plan"
}
],
"createdAt": "STRING - When the job was created. Format not specified in the plan",
"expiresAt": "NUMBER - When the record expires (TTL attribute). Likely epoch seconds, not confirmed"
}
sandboxCleanup record
Each cleanup is one record. Its status is Preparing, Executing, or Completed. The results object holds removedObjects (category, creator, and name of each removed item) and errors (category, item ID, and the error code and message).
TODO(user): list the remaining fields of the record.
auditLogs record
An audit log entry has auditLogID, timestamp, expiresAt, assetName, category, action, status (Success or Failure), user (email, name, user ID), and context (a message and optional data).