Default Tenant

POST 
/tenants/default-tenant

Sets the tenant specified in the request body as the default one, resolving all the incoming API request to that tenant when the env SINGLE_TENANT_MODE is set to true. Once set, the default tenant can be overwritten but never unset, although it is only effective when SINGLE_TENANT_MODE is set to true.

Default tenant is useful for development purposes or when the SDP is used by a single organization. This allows the organization to skip specifying the tenant in every request and simplifies the SDP setup operationally by removing the need of providing wildcard TLS certificates for multi-tenant configurations.

Request

*/*

Body

id stringrequired

The tenant id.

Responses

201

Default tenant details

application/json

Schema

Schema

id stringrequired
name stringrequired

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

base_url stringrequired

The SDP backend server's base URL.

sdp_ui_base_url stringrequired

The SDP UI/dashboard Base URL.

status stringrequired

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

distribution_account_address stringrequired

The Stellar account address used for distributing funds.

distribution_account_type stringrequired

Possible values: [DISTRIBUTION_ACCOUNT.STELLAR.ENV, DISTRIBUTION_ACCOUNT.STELLAR.DB_VAULT, DISTRIBUTION_ACCOUNT.CIRCLE.DB_VAULT]

The Stellar account type used for distributing funds.

distribution_account_status stringrequired

Possible values: [ACTIVE, PENDING_USER_ACTIVATION]

The status of the distribution account used for distributing funds.

is_default booleanrequired

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

application/json

Schema

Schema

error string

extras

object

status number

message string

Example (from schema)

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

Example

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

403

Forbidden

application/json

Schema

Schema

error string

Example (from schema)

{
  "error": "Forbidden"
}

Example

{
  "error": "Forbidden"
}

Loading...