Update key scopes or policy

Update key scopes or policy

When to use this: Adjust key permissions or policy constraints on an existing key.

Required scope: keys.write.

PATCH /user/v1/keys/{keyId}

Update key scopes or policy

cURL

curl --request PATCH \
  --url https://api.machines.cash/user/v1/keys/{keyId} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "scopes": [
    "cards.read"
  ],
  "revoke": false
}
'

200

{
  "ok": true,
  "data": {},
  "summary": "success"
}

Authorizations

Authorization · string · header · required

Bearer session token for User API operations. Legacy UserSessionBearer naming remains supported.

Path Parameters

keyId · string · required

User key id to update.

Body

application/json

scopes · enum<string>[]

Available options: users.read, users.write, kyc.read, kyc.write, agreements.read, agreements.write, onboarding.read, onboarding.write, cards.read, cards.write, cards.secrets.read, folders.read, folders.write, balances.read, contracts.read, contracts.write, deposits.read, deposits.write, withdrawals.write, transactions.read, tokens.read, encryption.read, encryption.write, identity.read, identity.write, payments.read, payments.write, subscriptions.read, subscriptions.write, notifications.read, notifications.write, referrals.read, referrals.write, bills.read, bills.write, support.read, spotlight.read, keys.read, keys.write, sessions.write

policy · object

Show child attributes

revoke · boolean

Response

200

application/json

Success

id · string

keyPrefix · string

scopes · string[]

policy · object

Show child attributes

createdAt · string<date-time>

revokedAt · string<date-time> | null