Permissions actions

Call Permissions methods with an explicit Para client

Import actions from @getpara/react-sdk, @getpara/react-sdk-lite or @getpara/react-native-wallet. Each action takes a Para client first, then the positional arguments of the Para client method of the same name, and returns the same promise. Actions work outside React components, but the client you pass must meet the method’s access rules.

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

const settings = await getUserPolicyParameters(para, policyId);

Errors

An action rejects with the error its client method throws, described on each method page. An undefined client fails with no para instance before any request. Permissions errors lists every server error.

Policy discovery

Read active policy definitions for your app or for a wallet of the signed-in user.

listPolicies

Lists your app's active policies that do not target specific users or wallets.

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

Arguments, result, and Portal behavior.

getPolicy

Reads the active version of a policy that does not target specific users or wallets.

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

Arguments, result, and Portal behavior.

listApplicablePolicies

Lists the active policies that apply to a wallet of the signed-in user.

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

Arguments, result, and Portal behavior.

getApplicablePolicy

Reads one active policy that applies to a wallet of the signed-in user.

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

Arguments, result, and Portal behavior.

Consent

Read a wallet’s consent state or build the Portal link where its owner reviews a Request.

listUserPolicyConsents

Lists the consent requests for a wallet of the signed-in user, with the status of each.

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

Arguments, result, and Portal behavior.

getUserPolicyConsent

Reads the consent status of one policy for a wallet of the signed-in user.

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

Arguments, result, and Portal behavior.

getPolicyConsentUrl

Builds the Portal URL where the signed-in user reviews a policy and consents to it.

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

Arguments, result, and Portal behavior.

Adjustable parameters

Read, save or reset the signed-in user’s personal parameter values, and inspect their saved history.

listUserAdjustablePolicies

Lists the policies whose parameters the signed-in user can adjust, with the user's current values.

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

Arguments, result, and Portal behavior.

getUserPolicyParameters

Reads the signed-in user's values for one policy's adjustable parameters, with the declarations and current revision.

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

Arguments, result, and Portal behavior.

updateUserPolicyParameters

Saves the signed-in user's values for a policy's adjustable parameters.

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

Arguments, result, and Portal behavior.

resetUserPolicyParameters

Restores the policy defaults as the signed-in user's values for its adjustable parameters.

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

Arguments, result, and Portal behavior.

listUserPolicyParameterHistory

Lists the saved revisions of the signed-in user's values for one policy, newest first.

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

Arguments, result, and Portal behavior.

Approval configuration

Find configurable requirements, read their settings and update or reset them for an authorization scope.

listConfigurableApprovalRequirements

Lists the approval requirements the signed-in user can configure in an authorization scope.

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

Arguments, result, and Portal behavior.

getConfigurableApprovalRequirement

Reads one approval requirement the signed-in user can configure, in a specific policy version.

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

Arguments, result, and Portal behavior.

getApprovalConfiguration

Reads the stored settings and revision for an approval requirement in an authorization scope.

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

Arguments, result, and Portal behavior.

getEffectiveApprovalConfiguration

Reads an approval requirement with the stored settings for an authorization scope applied.

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

Arguments, result, and Portal behavior.

updateApprovalConfiguration

Saves new values for an approval requirement's configurable settings in an authorization scope.

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

Arguments, result, and Portal behavior.

resetApprovalConfiguration

Clears the stored settings for an approval requirement so the authored defaults apply again.

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

Arguments, result, and Portal behavior.

listApprovalConfigurationHistory

Lists every stored revision of an approval requirement's settings in an authorization scope, newest first.

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

Arguments, result, and Portal behavior.

Roles and scopes

Read the signed-in user’s assignments and the requirements they can configure in a scope.

getUserApprovalAssignments

Reads the signed-in user's roles and attributes in an authorization scope.

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

Arguments, result, and Portal behavior.

getUserApprovalCapabilities

Lists the approval requirements the signed-in user can configure in an authorization scope.

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

Arguments, result, and Portal behavior.

Approval cases

Read cases the user can review or initiated, record eligible decisions, cancel a pending case or open its Portal review.

listAccessibleApprovalCases

Lists the approval cases the signed-in user can review, and the signature collections they started.

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

Arguments, result, and Portal behavior.

getAccessibleApprovalCase

Reads an approval case the signed-in user can review, with the user's decision options.

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

Arguments, result, and Portal behavior.

listInitiatedApprovalCases

Lists the approval cases for requests the signed-in user started, newest first.

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

Arguments, result, and Portal behavior.

getInitiatedApprovalCase

Reads an approval case for a request the signed-in user started.

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

Arguments, result, and Portal behavior.

approveApprovalCase

Records the signed-in approver's approval on an approval case.

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

Arguments, result, and Portal behavior.

rejectApprovalCase

Records the signed-in approver's rejection, which ends the approval case.

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

Arguments, result, and Portal behavior.

cancelApprovalCase

Cancels a pending approval case for a request the signed-in user started.

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

Arguments, result, and Portal behavior.

getApprovalCaseReviewUrl

Builds the Portal URL where the signed-in approver reviews an approval case.

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

Arguments, result, and Portal behavior.

Signature collection

Start a collection, read its payload and submit or collect signatures from approvers’ wallets.

createApprovalSignatureCollection

Opens an approval case that collects approvers' signatures for a transaction.

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

Arguments, result, and Portal behavior.

getApprovalSigningPayload

Reads what the signed-in approver signs in the current stage of a signature collection.

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

Arguments, result, and Portal behavior.

submitApprovalSignature

Submits the signed-in approver's signature to a signature collection.

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

Arguments, result, and Portal behavior.

getApprovalSignatures

Reads the collected signatures once a signature collection is complete.

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

Arguments, result, and Portal behavior.

signApprovalTransaction

Signs a signature collection's payload with one of the signed-in approver's wallets and submits the signature.

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

Arguments, result, and Portal behavior.

Usage

Read the current spend meters for a policy and the selected wallet, network and asset.

getUserPolicyUsage

Reads the current spend usage of a policy for a wallet of the signed-in user.

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

Arguments, result, and Portal behavior.