Permissions hooks - Para Docs

Import these hooks from @getpara/react-sdk or @getpara/react-sdk-lite inside your Para provider. They wrap the core permissions methods and retain the same authorization and Portal behavior.

Query hooks

Query hooks take the same positional arguments as their core method. They return TanStack Query UseQueryResult<Result, Error> with data, error, isPending, and refetch. Public discovery runs when a client exists; other queries wait for a fully authenticated user.

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

const { data, isPending, error } = useApplicablePolicies({ walletId });
const policies = data?.policies;

usePolicies

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

usePolicies(): UseQueryResult<PermissionsV2PolicyListResponse, Error>

Arguments, result, and access requirements.

usePolicy

Reads a publicly discoverable active policy and its authored defaults.

usePolicy(policyId: string): UseQueryResult<PermissionsV2PolicyResponse, Error>

Arguments, result, and access requirements.

useApplicablePolicies

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

useApplicablePolicies(context: PermissionsV2WalletContext): UseQueryResult<PermissionsV2PolicyListResponse, Error>

Arguments, result, and access requirements.

useApplicablePolicy

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

useApplicablePolicy(policyId: string, context: PermissionsV2WalletContext): UseQueryResult<PermissionsV2PolicyResponse, Error>

Arguments, result, and access requirements.

useUserPolicyConsents

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

useUserPolicyConsents(context: PermissionsV2ConsentListContext): UseQueryResult<PermissionsV2DelegationConsentDiscoveryResponse, Error>

Arguments, result, and access requirements.

useUserPolicyConsent

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

useUserPolicyConsent(policyId: string, context: PermissionsV2WalletContext): UseQueryResult<PermissionsV2DelegationConsentView, Error>

Arguments, result, and access requirements.

useUserAdjustablePolicies

Lists policies with adjustable parameters available to the user.

useUserAdjustablePolicies(): UseQueryResult<PermissionsV2UserAdjustablePolicyListResponse, Error>

Arguments, result, and access requirements.

useUserPolicyParameters

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

useUserPolicyParameters(policyId: string): UseQueryResult<PermissionsV2UserParameterView, Error>

Arguments, result, and access requirements.

useUserPolicyParameterHistory

Lists saved parameter revisions for the user and policy.

useUserPolicyParameterHistory(policyId: string, options?: PermissionsV2HistoryOptions): UseQueryResult<PermissionsV2UserParameterHistory, Error>

Arguments, result, and access requirements.

useConfigurableApprovalRequirements

Lists approval requirements that expose configuration in an authorization scope.

useConfigurableApprovalRequirements(authorizationScopeId: string): UseQueryResult<PermissionsV2ConditionalRequirementList, Error>

Arguments, result, and access requirements.

useConfigurableApprovalRequirement

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

useConfigurableApprovalRequirement(reference: PermissionsV2ApprovalRequirementReference): UseQueryResult<PermissionsV2ConditionalRequirementView, Error>

Arguments, result, and access requirements.

useApprovalConfiguration

Reads the stored configuration and revision for an approval requirement.

useApprovalConfiguration(reference: PermissionsV2ApprovalRequirementReference): UseQueryResult<PermissionsV2AuthorizationConfigurationView, Error>

Arguments, result, and access requirements.

useEffectiveApprovalConfiguration

Reads the approval requirement after applying its current configuration.

useEffectiveApprovalConfiguration(reference: PermissionsV2ApprovalRequirementReference): UseQueryResult<PermissionsV2EffectiveAuthorizationConfiguration, Error>

Arguments, result, and access requirements.

useApprovalConfigurationHistory

Lists configuration revisions for an approval requirement.

useApprovalConfigurationHistory(reference: PermissionsV2ApprovalRequirementReference): UseQueryResult<PermissionsV2AuthorizationConfigurationHistory, Error>

Arguments, result, and access requirements.

useUserApprovalAssignments

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

useUserApprovalAssignments(authorizationScopeId: string): UseQueryResult<PermissionsV2AuthoritySetView, Error>

Arguments, result, and access requirements.

useUserApprovalCapabilities

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

useUserApprovalCapabilities(authorizationScopeId: string): UseQueryResult<PermissionsV2AuthorizationScopeCapabilities, Error>

Arguments, result, and access requirements.

useAccessibleApprovalCases

Lists approval cases accessible to the signed-in approver.

useAccessibleApprovalCases(): UseQueryResult<{ cases: PermissionsV2ConditionalApprovalCaseView[] }, Error>

Arguments, result, and access requirements.

useAccessibleApprovalCase

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

useAccessibleApprovalCase(caseId: string): UseQueryResult<PermissionsV2ConditionalApprovalCaseView, Error>

Arguments, result, and access requirements.

useInitiatedApprovalCases

Lists approval cases initiated by the signed-in user.

useInitiatedApprovalCases(options?: PermissionsV2CaseListOptions): UseQueryResult<PermissionsV2ConditionalApprovalCaseList, Error>

Arguments, result, and access requirements.

useInitiatedApprovalCase

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

useInitiatedApprovalCase(caseId: string): UseQueryResult<PermissionsV2ConditionalApprovalCaseView, Error>

Arguments, result, and access requirements.

useApprovalSigningPayload

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

useApprovalSigningPayload(caseId: string): UseQueryResult<PermissionsV2ApprovalSigningPayload, Error>

Arguments, result, and access requirements.

useApprovalSignatures

Reads the completed signature bundle for the authenticated collection initiator.

useApprovalSignatures(caseId: string): UseQueryResult<PermissionsV2ApprovalSignatures, Error>

Arguments, result, and access requirements.

useUserPolicyUsage

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

useUserPolicyUsage(policyId: string, context: PermissionsV2UsageContext): UseQueryResult<PermissionsV2PolicyUsage, Error>

Arguments, result, and access requirements.

Mutation hooks

Mutation hooks take no arguments. The returned functions are named after the core method: method(variables) starts a mutation and methodAsync(variables) returns its promise. Results also include data, error, isPending, and reset. Successful writes invalidate the current user’s permissions queries; generating a Portal URL does not.

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

const { getPolicyConsentUrlAsync, isPending } = useGetPolicyConsentUrl();
const url = await getPolicyConsentUrlAsync({ walletId, policyId });
// Open the returned URL from your application.

useUpdateUserPolicyParameters

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

const { updateUserPolicyParameters, updateUserPolicyParametersAsync, data, error, isPending, reset } = useUpdateUserPolicyParameters();
// Mutation variables: { policyId: string; body: PermissionsV2UserParameterSave }
// updateUserPolicyParametersAsync returns Promise<PermissionsV2UserParameterView>.

Arguments, result, and access requirements.

useResetUserPolicyParameters

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

const { resetUserPolicyParameters, resetUserPolicyParametersAsync, data, error, isPending, reset } = useResetUserPolicyParameters();
// Mutation variables: { policyId: string; body: PermissionsV2UserParameterReset }
// resetUserPolicyParametersAsync returns Promise<PermissionsV2UserParameterView>.

Arguments, result, and access requirements.

useUpdateApprovalConfiguration

Updates the configurable values explicitly permitted by an approval requirement.

const { updateApprovalConfiguration, updateApprovalConfigurationAsync, data, error, isPending, reset } = useUpdateApprovalConfiguration();
// Mutation variables: { reference: PermissionsV2ApprovalRequirementReference; body: PermissionsV2AuthorizationConfigurationWrite }
// updateApprovalConfigurationAsync returns Promise<PermissionsV2AuthorizationConfigurationView>.

Arguments, result, and access requirements.

useResetApprovalConfiguration

Clears configured overrides and restores the requirement’s defaults.

const { resetApprovalConfiguration, resetApprovalConfigurationAsync, data, error, isPending, reset } = useResetApprovalConfiguration();
// Mutation variables: { reference: PermissionsV2ApprovalRequirementReference; expectedRevision: number }
// resetApprovalConfigurationAsync returns Promise<PermissionsV2AuthorizationConfigurationView>.

Arguments, result, and access requirements.

useApproveApprovalCase

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

const { approveApprovalCase, approveApprovalCaseAsync, data, error, isPending, reset } = useApproveApprovalCase();
// Mutation variables: string
// approveApprovalCaseAsync returns Promise<PermissionsV2ConditionalApprovalCaseView>.

Arguments, result, and access requirements.

useRejectApprovalCase

Records a rejection from the signed-in eligible approver.

const { rejectApprovalCase, rejectApprovalCaseAsync, data, error, isPending, reset } = useRejectApprovalCase();
// Mutation variables: string
// rejectApprovalCaseAsync returns Promise<PermissionsV2ConditionalApprovalCaseView>.

Arguments, result, and access requirements.

useCreateApprovalSignatureCollection

Creates a policy-governed signature collection for a transaction.

const { createApprovalSignatureCollection, createApprovalSignatureCollectionAsync, data, error, isPending, reset } = useCreateApprovalSignatureCollection();
// Mutation variables: PermissionsV2TransactionSignatureCollection
// createApprovalSignatureCollectionAsync returns Promise<PermissionsV2ApprovalSignatureCollectionResult>.

Arguments, result, and access requirements.

useSubmitApprovalSignature

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

const { submitApprovalSignature, submitApprovalSignatureAsync, data, error, isPending, reset } = useSubmitApprovalSignature();
// Mutation variables: { caseId: string; body: PermissionsV2ConditionalApprovalSignature }
// submitApprovalSignatureAsync returns Promise<PermissionsV2ConditionalApprovalCaseView>.

Arguments, result, and access requirements.

useSignApprovalTransaction

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

const { signApprovalTransaction, signApprovalTransactionAsync, data, error, isPending, reset } = useSignApprovalTransaction();
// Mutation variables: SignApprovalTransactionParams
// signApprovalTransactionAsync returns Promise<PermissionsV2ConditionalApprovalCaseView>.

Arguments, result, and access requirements.

useGetPolicyConsentUrl

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

const { getPolicyConsentUrl, getPolicyConsentUrlAsync, data, error, isPending, reset } = useGetPolicyConsentUrl();
// Mutation variables: { walletId: string; policyId: string }
// getPolicyConsentUrlAsync returns Promise<string>.

Arguments, result, and access requirements.

useGetApprovalCaseReviewUrl

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

const { getApprovalCaseReviewUrl, getApprovalCaseReviewUrlAsync, data, error, isPending, reset } = useGetApprovalCaseReviewUrl();
// Mutation variables: { caseId: string }
// getApprovalCaseReviewUrlAsync returns Promise<string>.

Arguments, result, and access requirements.

​Query hooks

​usePolicies

​usePolicy

​useApplicablePolicies

​useApplicablePolicy

​useUserPolicyConsents

​useUserPolicyConsent

​useUserAdjustablePolicies

​useUserPolicyParameters

​useUserPolicyParameterHistory

​useConfigurableApprovalRequirements

​useConfigurableApprovalRequirement

​useApprovalConfiguration

​useEffectiveApprovalConfiguration

​useApprovalConfigurationHistory

​useUserApprovalAssignments

​useUserApprovalCapabilities

​useAccessibleApprovalCases

​useAccessibleApprovalCase

​useInitiatedApprovalCases

​useInitiatedApprovalCase

​useApprovalSigningPayload

​useApprovalSignatures

​useUserPolicyUsage

​Mutation hooks

​useUpdateUserPolicyParameters

​useResetUserPolicyParameters

​useUpdateApprovalConfiguration

​useResetApprovalConfiguration

​useApproveApprovalCase

​useRejectApprovalCase

​useCreateApprovalSignatureCollection

​useSubmitApprovalSignature

​useSignApprovalTransaction

​useGetPolicyConsentUrl

​useGetApprovalCaseReviewUrl

Query hooks

usePolicies

usePolicy

useApplicablePolicies

useApplicablePolicy

useUserPolicyConsents

useUserPolicyConsent

useUserAdjustablePolicies

useUserPolicyParameters

useUserPolicyParameterHistory

useConfigurableApprovalRequirements

useConfigurableApprovalRequirement

useApprovalConfiguration

useEffectiveApprovalConfiguration

useApprovalConfigurationHistory

useUserApprovalAssignments

useUserApprovalCapabilities

useAccessibleApprovalCases

useAccessibleApprovalCase

useInitiatedApprovalCases

useInitiatedApprovalCase

useApprovalSigningPayload

useApprovalSignatures

useUserPolicyUsage

Mutation hooks

useUpdateUserPolicyParameters

useResetUserPolicyParameters

useUpdateApprovalConfiguration

useResetApprovalConfiguration

useApproveApprovalCase

useRejectApprovalCase

useCreateApprovalSignatureCollection

useSubmitApprovalSignature

useSignApprovalTransaction

useGetPolicyConsentUrl

useGetApprovalCaseReviewUrl