Tenant

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://developers.stellar.org/schemas/sdp/Tenant.json",
  "title": "Tenant",
  "type": "object",
  "properties": {
    "id": {
      "type": "string",
      "example": "1736bed3-7b92-4760-8ff2-51fb08ee079f"
    },
    "name": {
      "type": "string",
      "description": "The tenant name. It should match the pattern `^[a-z-]+$`.",
      "example": "bluecorp"
    },
    "base_url": {
      "type": "string",
      "description": "The SDP backend server's base URL.",
      "example": "https://bluecorp-backend.sdp.org"
    },
    "sdp_ui_base_url": {
      "type": "string",
      "description": "The SDP UI/dashboard Base URL.",
      "example": "https://bluecorp.sdp.org"
    },
    "status": {
      "type": "string",
      "enum": [
        "TENANT_CREATED",
        "TENANT_PROVISIONED",
        "TENANT_ACTIVATED",
        "TENANT_DEACTIVATED"
      ]
    },
    "distribution_account_address": {
      "type": "string",
      "description": "The Stellar account address used for distributing funds.",
      "example": "GCXAJ3XJ3VK3JFH3QMDFOSKM2NMMZBSO3VIT6EUPQWSDW2J74M23RRSL"
    },
    "distribution_account_type": {
      "type": "string",
      "description": "The Stellar account type used for distributing funds.",
      "enum": [
        "DISTRIBUTION_ACCOUNT.STELLAR.ENV",
        "DISTRIBUTION_ACCOUNT.STELLAR.DB_VAULT",
        "DISTRIBUTION_ACCOUNT.CIRCLE.DB_VAULT"
      ]
    },
    "distribution_account_status": {
      "type": "string",
      "description": "The status of the distribution account used for distributing funds.",
      "enum": [
        "ACTIVE",
        "PENDING_USER_ACTIVATION"
      ]
    },
    "is_default": {
      "type": "boolean",
      "description": "Boolean flag that shows whether the tenant is the default or not.",
      "default": false
    },
    "created_at": {
      "type": "string",
      "format": "date-time",
      "example": "2024-03-27T17:21:51Z"
    },
    "updated_at": {
      "type": "string",
      "format": "date-time",
      "example": "2024-03-27T17:21:51Z"
    },
    "deleted_at": {
      "type": "string",
      "description": "The timestamp when the tenant was (soft) deleted.",
      "format": "date-time",
      "example": "2024-03-27T17:21:51Z"
    }
  },
  "required": [
    "base_url",
    "created_at",
    "distribution_account_address",
    "distribution_account_status",
    "distribution_account_type",
    "id",
    "is_default",
    "name",
    "sdp_ui_base_url",
    "status",
    "updated_at"
  ],
  "example": {
    "id": "840dca45-d1df-44cd-83c1-65c04235c25f",
    "name": "redcorp",
    "base_url": "https://redcorp-backend.sdp.org",
    "sdp_ui_base_url": "https://redcorp.sdp.org",
    "status": "TENANT_PROVISIONED",
    "distribution_account": "GCQVDMPOEN3HHJJ64V42KUTONOXN7C6V2PSVPALEVJ7PIYOB6M3DJV7N",
    "is_default": true,
    "created_at": "2024-03-27T17:21:51.000Z",
    "updated_at": "2024-03-27T17:21:51.000Z"
  }
}