Skip to content

Create a new tenant

Request

Creates a new tenant.

Security
Bearer
Bodyapplication/jsonrequired
tenant_idstringrequired

Tenant ID of the tenant.

Example:"urn:ripplexcurrent-prod:name"
callback_enabledboolean

Flag to denote whether callback is enabled for this tenant.

Default:false
Example:false
callback_urlstring, [ 1 .. 256 ] characters^(http[s]?:\/\/)[\w@%.\\+~#=-]{2,256}(:[0-9]{...

URL to be invoked for callback for this tenant. Mandatory if callback_enabled is true.

xcurrent_client_idstring, [ 1 .. 256 ] characters^[a-zA-Z0-9@_,.\s-]*$

Client ID for connecting to RippleNet for this tenant. Mandatory if credentials have to be managed locally.

xcurrent_passwordstring, [ 1 .. 256 ] characters^[a-zA-Z0-9@_,.\s-]*$

Password for connecting to RippleNet for this tenant. Mandatory if credentials have to be managed locally.

xcurrent_connection_timeoutinteger, (int32)

Timeout, in milliseconds, to obtain a connection with RippleNet for this tenant.

Default:10000
xcurrent_socket_timeoutinteger, (int32)

Timeout, in milliseconds, to obtain a response for a RippleNet API operation for this tenant.

Default:60000
xcurrent_urlstring, [ 1 .. 256 ] characters^(http[s]?:\/\/)[\w@%.\\+~#=-]{2,256}(:[0-9]{...required

URL of the RippleNet (RN node) system to which orchestration service connects.

curl -i -X POST \
  https://docs.ripple.com/_mock/products/payments-odl/api-docs/ripplenet/ripplenet/v4/orchestration/config/tenant \
  -H 'Authorization: YOUR_API_KEY_HERE' \
  -H 'Content-Type: application/json' \
  -d '{
    "tenant_id": "urn:ripplexcurrent-prod:name",
    "callback_enabled": false,
    "callback_url": "string",
    "xcurrent_client_id": "string",
    "xcurrent_password": "string",
    "xcurrent_connection_timeout": 10000,
    "xcurrent_socket_timeout": 60000,
    "xcurrent_url": "string"
  }'

Responses

Successfully created tenant.

Bodyapplication/json
tenant_idstring

Tenant ID of the tenant.

Example:"urn:ripplexcurrent-prod:name"
callback_enabledboolean

Flag to denote whether callback is enabled for this tenant.

Example:false
callback_urlstring

URL to be invoked for callback for this tenant. Mandatory if callback_enabled is true.

xcurrent_client_idstring

Client ID for connecting to RippleNet for this tenant. Mandatory if credentials have to be managed locally.

xcurrent_passwordstring

Password for connecting to RippleNet for this tenant. Mandatory if credentials have to be managed locally.

xcurrent_connection_timeoutinteger

Timeout, in milliseconds, to obtain a connection with RippleNet for this tenant.

xcurrent_socket_timeoutinteger

Timeout, in milliseconds, to obtain a response for a RippleNet API operation for this tenant.

xcurrent_urlstring

URL of the RippleNet (RN node) system to which orchestration service connects.

Response
{
  "tenant_id": "urn:ripplexcurrent-prod:name",
  "callback_enabled": false,
  "callback_url": "string",
  "xcurrent_client_id": "string",
  "xcurrent_password": "string",
  "xcurrent_connection_timeout": 0,
  "xcurrent_socket_timeout": 0,
  "xcurrent_url": "string"
}