updateApprovalConfiguration

Usage

Available on the Para client in @getpara/web-sdk, @getpara/react-sdk, @getpara/react-sdk-lite, @getpara/server-sdk and @getpara/react-native-wallet, through @getpara/core-sdk.

const { configuration } = await para.getEffectiveApprovalConfiguration(reference);
const body = { expectedRevision: configuration?.revision ?? 0, values: { "finance-approvals": 2 } };
const saved = await para.updateApprovalConfiguration(reference, body);

Signature

updateApprovalConfiguration(reference: PermissionsV2ApprovalRequirementReference, body: PermissionsV2AuthorizationConfigurationWrite): Promise<PermissionsV2AuthorizationConfigurationView>

Key values by the setting id the policy declares. Send 0 as expectedRevision for the first write. A minimum_amount setting must stay inside the range the requirement declares. Unless the policy sets a max, the published threshold is the upper bound, so the setting can lower the threshold but not raise it. A value outside the range fails with safe_knob_value_invalid.

An approval case is open while it is pending, and after it completes until it is used to sign or expires. Para refuses a change that would invalidate open cases until you confirm it. A confirmed change ends those cases as invalidated, and their requests need a new attempt.Through the API, a refused change returns 409 with code APPROVAL_CASES_AFFECTED and the case IDs in affectedCaseIds, and nothing changes. To confirm it, send the same change again with force: true.In the client SDKs, the error is a PermissionsV2ApprovalCasesAffectedError with the case IDs in affectedCaseIds. Every client SDK package exports it. Show the user those cases before you retry with force.

import { PermissionsV2ApprovalCasesAffectedError } from "@getpara/web-sdk";

try {
  await para.updateApprovalConfiguration(reference, body);
} catch (error) {
  if (!(error instanceof PermissionsV2ApprovalCasesAffectedError)) throw error;
  const confirmed = window.confirm(`Invalidate ${error.affectedCaseIds.length} open approval cases?`);
  if (confirmed) await para.updateApprovalConfiguration(reference, { ...body, force: true });
}

Access and Portal behavior

Signed-in configuration manager. The user’s roles and attributes in the authorization scope must match the requirement’s configuration managers. Does not open Portal.

Errors

A failed request rejects with an error that carries status, code and message. A few refusals have their own code, such as POLICY_DENIED, INITIATOR_CANNOT_REVIEW and APPROVAL_CASES_AFFECTED. Most arrive as plain text, with code set to ERR_BAD_REQUEST for a 4xx status and the server message in message, so branch on message for those. Rows marked Client throw a plain Error with only a message, before any request is sent, so call the method inside try with await to catch every error. Permissions errors lists every error.

Status	Message	When
Client	`no userId is set`	No user is signed in, or the session is a guest session.
400	A validation code such as `safe_knob_value_invalid`	A value is not declared by the requirement or is outside its bounds.
403	`permissions v2 extension is not available for this partner`	Conditional approvals are not enabled for your API key. Contact Para to enable them.
403	`user is not an eligible configuration manager for this authorization scope`	The user’s roles and attributes in the scope do not make them a configuration manager.
403	`this requirement does not allow configuration managers`	The requirement does not let configuration managers change it.
404	`active conditional approval requirement not found`	No active requirement matches the reference, for example because `policyVersion` is no longer active.
409	`conditional approval configuration changed; read the current revision and retry`	`expectedRevision` is not the current revision.
409	`change would invalidate open approval cases; retry with force to apply it`	The change would invalidate open approval cases. The error is a `PermissionsV2ApprovalCasesAffectedError` with `code: "APPROVAL_CASES_AFFECTED"` and the case IDs in `affectedCaseIds`.

Overview

Client Methods

Actions

React Hooks

Signers & Integrations

Smart Accounts

Wallet Connectors

REST SDK

Types & Configuration

updateApprovalConfiguration

Usage

Access and Portal behavior

Errors

​Usage

​Access and Portal behavior

​Errors

Usage

Access and Portal behavior

Errors