Skip to main content

Create Tenant

POST 

/tenants

Create Tenant

Request

Body

    name stringrequired

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

    owner_email stringrequired

    The owner user e-mail address

    owner_first_name stringrequired

    The owner user first name

    owner_last_name stringrequired

    The owner user last name

    organization_name stringrequired

    The organization name

    base_url string

    The SDP backend server's base URL. If this field is not provided, the SDP will generate one based on the host BASE_URL configuration, and the tenant name.

    sdp_ui_base_url string

    The SDP UI/dashboard Base URL. If this field is not provided, the SDP will generate one based on the host SDP_UI_BASE_URL configuration, and the tenant name.

Responses

Provision a new tenant

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.

Loading...