Retrieve a Tenant
GET/tenants/:arg
Retrieve a Tenant
Request
Path Parameters
arg stringrequired
ID or Name of the Tenant
.
Responses
- 200
- 401
- 404
Tenant details
- application/json
- Schema
- Example (from 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.
{
"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"
}
Unauthorized
Response Headers
- application/json
- Schema
- Example (from schema)
- response
Schema
error string
extras object
status number
message string
{
"error": "Not authorized",
"extras": {
"status": 401,
"message": "Not authorized"
}
}
{
"error": "Not authorized",
"extras": {
"status": 401,
"message": "Not authorized"
}
}
Not Found
Response Headers
- application/json
- Schema
- Example (from schema)
- response
Schema
error string
extras object
status number
message string
{
"error": "string",
"extras": {
"status": 0,
"message": "string"
}
}
{
"error": "Not found",
"extras": {
"status": 404,
"message": "Resource not found"
}
}
Loading...