private/toggle_subaccount_login

Enables or disables direct login access for a subaccount. When login is disabled, the subaccount cannot be accessed directly using email and password authentication, but can still be accessed through the main account.

If login is disabled while an active session exists for the subaccount, that session will be immediately terminated.

TFA required

📖 Related Article: Managing Subaccounts

Scope: account:read_write

Try in API console

cURL

cURL

curl --request GET \
  --url https://test.deribit.com/api/v2/private/toggle_subaccount_login \
  --header 'Content-Type: application/json' \
  --data '
{
  "jsonrpc": "2.0",
  "id": 938,
  "method": "private/toggle_subaccount_login",
  "params": {
    "sid": 7,
    "state": "enable"
  }
}
'

import requests

url = "https://test.deribit.com/api/v2/private/toggle_subaccount_login"

payload = {
    "jsonrpc": "2.0",
    "id": 938,
    "method": "private/toggle_subaccount_login",
    "params": {
        "sid": 7,
        "state": "enable"
    }
}
headers = {"Content-Type": "application/json"}

response = requests.get(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'GET',
  headers: {'Content-Type': 'application/json'},
  body: JSON.stringify({
    jsonrpc: '2.0',
    id: 938,
    method: 'private/toggle_subaccount_login',
    params: {sid: 7, state: 'enable'}
  })
};

fetch('https://test.deribit.com/api/v2/private/toggle_subaccount_login', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://test.deribit.com/api/v2/private/toggle_subaccount_login",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_POSTFIELDS => json_encode([
    'jsonrpc' => '2.0',
    'id' => 938,
    'method' => 'private/toggle_subaccount_login',
    'params' => [
        'sid' => 7,
        'state' => 'enable'
    ]
  ]),
  CURLOPT_HTTPHEADER => [
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://test.deribit.com/api/v2/private/toggle_subaccount_login"

	payload := strings.NewReader("{\n  \"jsonrpc\": \"2.0\",\n  \"id\": 938,\n  \"method\": \"private/toggle_subaccount_login\",\n  \"params\": {\n    \"sid\": 7,\n    \"state\": \"enable\"\n  }\n}")

	req, _ := http.NewRequest("GET", url, payload)

	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.get("https://test.deribit.com/api/v2/private/toggle_subaccount_login")
  .header("Content-Type", "application/json")
  .body("{\n  \"jsonrpc\": \"2.0\",\n  \"id\": 938,\n  \"method\": \"private/toggle_subaccount_login\",\n  \"params\": {\n    \"sid\": 7,\n    \"state\": \"enable\"\n  }\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://test.deribit.com/api/v2/private/toggle_subaccount_login")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Content-Type"] = 'application/json'
request.body = "{\n  \"jsonrpc\": \"2.0\",\n  \"id\": 938,\n  \"method\": \"private/toggle_subaccount_login\",\n  \"params\": {\n    \"sid\": 7,\n    \"state\": \"enable\"\n  }\n}"

response = http.request(request)
puts response.read_body

200

{
  "jsonrpc": "2.0",
  "id": 1569,
  "result": "ok"
}

Query Parameters

sid · integer · required

The user id for the subaccount

Example:

7

state · enum<string> · required

enable or disable login.

Available options: enable, disable

Example:

"enable"

Response

200 - application/json

Success response

jsonrpc · enum<string> · required

The JSON-RPC version (2.0)

Available options: 2.0

result · enum<string> · required

Result of method execution. ok in case of success

Available options: ok

id · integer

The id that was sent in the request