Permissions actions - Para Docs

Import actions from @getpara/react-sdk or @getpara/react-sdk-lite. Each action takes a Para client first, followed by the exact positional arguments of its core method, and returns the same promise. Actions do not require a React hook, but the supplied client must satisfy the method’s authentication requirements. An undefined client throws no para instance.

import { getUserPolicyParameters } from "@getpara/react-sdk";

const settings = await getUserPolicyParameters(para, policyId);

Policy discovery

listPolicies

Lists publicly discoverable active policies for the application. Targeted user and wallet definitions are excluded.

listPolicies(para: ParaCore | undefined): Promise<PermissionsV2PolicyListResponse>

Arguments, result, and Portal behavior.

getPolicy

Reads a publicly discoverable active policy and its authored defaults.

getPolicy(para: ParaCore | undefined, policyId: string): Promise<PermissionsV2PolicyResponse>

Arguments, result, and Portal behavior.

listApplicablePolicies

Lists active policies applicable to the signed-in user and selected wallet.

listApplicablePolicies(para: ParaCore | undefined, context: PermissionsV2WalletContext): Promise<PermissionsV2PolicyListResponse>

Arguments, result, and Portal behavior.

getApplicablePolicy

Reads an active policy applicable to the signed-in user and selected wallet.

getApplicablePolicy(para: ParaCore | undefined, policyId: string, context: PermissionsV2WalletContext): Promise<PermissionsV2PolicyResponse>

Arguments, result, and Portal behavior.

listUserPolicyConsents

Lists consent requests and current consent state for the selected user wallet.

listUserPolicyConsents(para: ParaCore | undefined, context: PermissionsV2ConsentListContext): Promise<PermissionsV2DelegationConsentDiscoveryResponse>

Arguments, result, and Portal behavior.

getUserPolicyConsent

Reads the selected policy’s current consent state for a user wallet.

getUserPolicyConsent(para: ParaCore | undefined, policyId: string, context: PermissionsV2WalletContext): Promise<PermissionsV2DelegationConsentView>

Arguments, result, and Portal behavior.

getPolicyConsentUrl

Creates a Portal URL for policy consent without first submitting a transaction.

getPolicyConsentUrl(para: ParaCore | undefined, params: { walletId: string; policyId: string }): Promise<string>

Arguments, result, and Portal behavior.

Adjustable parameters

listUserAdjustablePolicies

Lists policies with adjustable parameters available to the user.

listUserAdjustablePolicies(para: ParaCore | undefined): Promise<PermissionsV2UserAdjustablePolicyListResponse>

Arguments, result, and Portal behavior.

getUserPolicyParameters

Reads parameter declarations, saved values, and the current settings revision.

getUserPolicyParameters(para: ParaCore | undefined, policyId: string): Promise<PermissionsV2UserParameterView>

Arguments, result, and Portal behavior.

updateUserPolicyParameters

Saves the signed-in user’s parameter values against the current policy version and settings revision.

updateUserPolicyParameters(para: ParaCore | undefined, policyId: string, body: PermissionsV2UserParameterSave): Promise<PermissionsV2UserParameterView>

Arguments, result, and Portal behavior.

resetUserPolicyParameters

Resets the signed-in user’s parameter values to the current policy defaults.

resetUserPolicyParameters(para: ParaCore | undefined, policyId: string, body: PermissionsV2UserParameterReset): Promise<PermissionsV2UserParameterView>

Arguments, result, and Portal behavior.

listUserPolicyParameterHistory

Lists saved parameter revisions for the user and policy.

listUserPolicyParameterHistory(para: ParaCore | undefined, policyId: string, options?: PermissionsV2HistoryOptions): Promise<PermissionsV2UserParameterHistory>

Arguments, result, and Portal behavior.

Approval configuration

listConfigurableApprovalRequirements

Lists approval requirements that expose configuration in an authorization scope.

listConfigurableApprovalRequirements(para: ParaCore | undefined, authorizationScopeId: string): Promise<PermissionsV2ConditionalRequirementList>

Arguments, result, and Portal behavior.

getConfigurableApprovalRequirement

Reads a configurable approval requirement in a specific policy version and authorization scope.

getConfigurableApprovalRequirement(para: ParaCore | undefined, reference: PermissionsV2ApprovalRequirementReference): Promise<PermissionsV2ConditionalRequirementView>

Arguments, result, and Portal behavior.

getApprovalConfiguration

Reads the stored configuration and revision for an approval requirement.

getApprovalConfiguration(para: ParaCore | undefined, reference: PermissionsV2ApprovalRequirementReference): Promise<PermissionsV2AuthorizationConfigurationView>

Arguments, result, and Portal behavior.

getEffectiveApprovalConfiguration

Reads the approval requirement after applying its current configuration.

getEffectiveApprovalConfiguration(para: ParaCore | undefined, reference: PermissionsV2ApprovalRequirementReference): Promise<PermissionsV2EffectiveAuthorizationConfiguration>

Arguments, result, and Portal behavior.

updateApprovalConfiguration

Updates the configurable values explicitly permitted by an approval requirement.

updateApprovalConfiguration(para: ParaCore | undefined, reference: PermissionsV2ApprovalRequirementReference, body: PermissionsV2AuthorizationConfigurationWrite): Promise<PermissionsV2AuthorizationConfigurationView>

Arguments, result, and Portal behavior.

resetApprovalConfiguration

Clears configured overrides and restores the requirement’s defaults.

resetApprovalConfiguration(para: ParaCore | undefined, reference: PermissionsV2ApprovalRequirementReference, expectedRevision: number): Promise<PermissionsV2AuthorizationConfigurationView>

Arguments, result, and Portal behavior.

listApprovalConfigurationHistory

Lists configuration revisions for an approval requirement.

listApprovalConfigurationHistory(para: ParaCore | undefined, reference: PermissionsV2ApprovalRequirementReference): Promise<PermissionsV2AuthorizationConfigurationHistory>

Arguments, result, and Portal behavior.

Roles and scopes

getUserApprovalAssignments

Reads roles and attributes assigned to a user in an authorization scope.

getUserApprovalAssignments(para: ParaCore | undefined, authorizationScopeId: string): Promise<PermissionsV2AuthoritySetView>

Arguments, result, and Portal behavior.

getUserApprovalCapabilities

Lists requirements the signed-in user is authorized to configure in an authorization scope.

getUserApprovalCapabilities(para: ParaCore | undefined, authorizationScopeId: string): Promise<PermissionsV2AuthorizationScopeCapabilities>

Arguments, result, and Portal behavior.

Approval cases

listAccessibleApprovalCases

Lists approval cases accessible to the signed-in approver.

listAccessibleApprovalCases(para: ParaCore | undefined): Promise<{ cases: PermissionsV2ConditionalApprovalCaseView[] }>

Arguments, result, and Portal behavior.

getAccessibleApprovalCase

Reads an approval case accessible to the signed-in approver.

getAccessibleApprovalCase(para: ParaCore | undefined, caseId: string): Promise<PermissionsV2ConditionalApprovalCaseView>

Arguments, result, and Portal behavior.

listInitiatedApprovalCases

Lists approval cases initiated by the signed-in user.

listInitiatedApprovalCases(para: ParaCore | undefined, options?: PermissionsV2CaseListOptions): Promise<PermissionsV2ConditionalApprovalCaseList>

Arguments, result, and Portal behavior.

getInitiatedApprovalCase

Reads an approval case initiated by the signed-in user, without granting approval authority.

getInitiatedApprovalCase(para: ParaCore | undefined, caseId: string): Promise<PermissionsV2ConditionalApprovalCaseView>

Arguments, result, and Portal behavior.

approveApprovalCase

Records an authenticated approval from the signed-in eligible approver.

approveApprovalCase(para: ParaCore | undefined, caseId: string): Promise<PermissionsV2ConditionalApprovalCaseView>

Arguments, result, and Portal behavior.

rejectApprovalCase

Records a rejection from the signed-in eligible approver.

rejectApprovalCase(para: ParaCore | undefined, caseId: string): Promise<PermissionsV2ConditionalApprovalCaseView>

Arguments, result, and Portal behavior.

getApprovalCaseReviewUrl

Creates a Portal URL to review an approval case accessible to the signed-in approver.

getApprovalCaseReviewUrl(para: ParaCore | undefined, params: { caseId: string }): Promise<string>

Arguments, result, and Portal behavior.

Signature collection

createApprovalSignatureCollection

Creates a policy-governed signature collection for a transaction.

createApprovalSignatureCollection(para: ParaCore | undefined, body: PermissionsV2TransactionSignatureCollection): Promise<PermissionsV2ApprovalSignatureCollectionResult>

Arguments, result, and Portal behavior.

getApprovalSigningPayload

Reads the canonical signing payload for a participant eligible to sign in the current stage.

getApprovalSigningPayload(para: ParaCore | undefined, caseId: string): Promise<PermissionsV2ApprovalSigningPayload>

Arguments, result, and Portal behavior.

submitApprovalSignature

Submits a signature and signer wallet for backend verification and collection.

submitApprovalSignature(para: ParaCore | undefined, caseId: string, body: PermissionsV2ConditionalApprovalSignature): Promise<PermissionsV2ConditionalApprovalCaseView>

Arguments, result, and Portal behavior.

getApprovalSignatures

Reads the completed signature bundle for the authenticated collection initiator.

getApprovalSignatures(para: ParaCore | undefined, caseId: string): Promise<PermissionsV2ApprovalSignatures>

Arguments, result, and Portal behavior.

signApprovalTransaction

Fetches the case’s canonical signing payload, signs with the selected wallet, and submits the signature.

signApprovalTransaction(para: ParaCore | undefined, params: SignApprovalTransactionParams): Promise<PermissionsV2ConditionalApprovalCaseView>

Arguments, result, and Portal behavior.

Usage

getUserPolicyUsage

Reads a current spending-usage snapshot for a policy and user wallet.

getUserPolicyUsage(para: ParaCore | undefined, policyId: string, context: PermissionsV2UsageContext): Promise<PermissionsV2PolicyUsage>

Arguments, result, and Portal behavior.