Update Prime API User Roles

Updates the role assigned to a Prime API user. Valid roles are Viewer and Trader.

POST /0/private/UpdatePrimeApiUserRoles

Update Prime API User Roles

cURL

curl --request POST \
  --url https://api.kraken.com/0/private/UpdatePrimeApiUserRoles \
  --header 'API-Key: <api-key>' \
  --header 'API-Sign: <api-key>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "nonce": 123,
  "user_id": "2T0RXL9B8K5D6",
  "role": "Trader"
}
'

200

{
  "result": {
    "id": "2T0RXL9B8K5D6",
    "name": "Test User",
    "status": "Enabled",
    "roles": [
      "Trader"
    ]
  },
  "error": [
    "EGeneral:Invalid arguments"
  ]
}

Authorizations

API-Key · string · header · required

The "API-Key" header should contain your API key.

API-Sign · string · header · required

Authenticated requests should be signed with the "API-Sign" header, using a signature generated with your private key, nonce, encoded payload, and URI path.

Body

application/json

nonce · integer<int64> · required

Nonce used in construction of API-Sign header

user_id · string · required

The unique identifier of the API user whose role to update.

Example:

"2T0RXL9B8K5D6"

role · enum<string> · required

Role to assign to the API user.

Available options: Trader, Viewer

Example:

"Trader"

Response

200

application/json

API user roles updated.

Response containing the Prime API user with updated roles.

result · object · required

Prime API user information.

Show child attributes

error · string[] · required

Kraken API error