Default Tenant

POST 
/tenants/default-tenant

Default Tenant

Request

application/json

Body

id stringrequired

The tenant id.

Responses

201

Set the given tenant as default when Single Tenant Mode is enabled. Once set, the default tenant can be overwritten but never unset.

application/json

Schema

Schema

id stringrequired
name stringrequired

The tenant name. It should match the pattern ^[a-z-]+$.

base_url string

The SDP backend server's base URL.

sdp_ui_base_url string

The SDP UI/dashboard Base URL.

status stringrequired

Possible values: [TENANT_CREATED, TENANT_PROVISIONED, TENANT_ACTIVATED, TENANT_DEACTIVATED]

distribution_account_address string

The Stellar account address used for distributing funds.

distribution_account_type string

Possible values: [ENV_STELLAR, DB_VAULT_STELLAR]

The Stellar account type used for distributing funds.

distribution_account_status string

Possible values: [ACTIVE, PENDING_USER_ACTIVATION]

The status of the distribution account used for distributing funds.

is_default boolean

Boolean flag that shows whether the tenant is the default or not.

created_at date-timerequired
updated_at date-timerequired
deleted_at date-time

The timestamp when the tenant was (soft) deleted.

Example (from schema)

{
  "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"
}

401

Unauthorized

Response Headers

application/json

Schema

Schema

error string

extras

object

status number

message string

Example (from schema)

{
  "error": "Not authorized",
  "extras": {
    "status": 401,
    "message": "Not authorized"
  }
}

response

{
  "error": "Not authorized",
  "extras": {
    "status": 401,
    "message": "Not authorized"
  }
}

403

Forbidden

Response Headers

application/json

Schema

Schema

error string

Example (from schema)

{
  "error": "Forbidden"
}

response

{
  "error": "Forbidden"
}

Loading...