API Permissions

Roles, menus, screen aliases, and system menus

Roles / API tab

The Roles / API tab is only shown for roles where "Access Type" is 'web-services'.

'web_services' is a standard role with this access type.

Only 'admin' users can view this tab and enable/disable permissions.

Available permissions are listed in alphanumeric order.

Go to the APIs page to see a list of the APIs that these permissions enable.

Note: To optimise security, only enable permissions for the individual APIs that you need.

Permissions

Permission	Description
Attachments:Delete	Delete an attachment
Attachments:Get	Get an attachment by attachment id, Get an attachment resource pre-signed URL
Attachments:Save	Save an attachment
Audit:UserIdOverride	Audit user ID override
Clients:Create	Create clients, copy client
Clients:Update	Patch client
Clients:Get	Get client
ClientCostCentres:Get	Get client cost centres
ClientIndustries:Get	Get client industries
CompetitorMargins:Get	Get competitor margins
Contract:FundsCheck	Contract funds check
ContractBilling:Edit	Edit contract billing
ContractBilling:Vary	Vary contract billing
ContractBudgets:Get	Get contract budgets
ContractBudgets:Insert	Insert contract budgets
ContractBudgets:Update	Update contract budgets
ContractEvents:ChangeDriver	Change driver by creating a driver change event
ContractEventActions:Get	Return a list of contract event actions
ContractEventValues:Get	Return a list of contract event values
ContractEventDescriptions:Get	Return a list of contract event descriptions
ContractEvents:Create	Create non-process-oriented contract events
DealTypes:Get	Get deal types
DriverAssets:Create	Create driver assets
DriverAssets:Delete	Delete driver assets
DriverAssets:Get	Get driver assets
DriverAssets:Update	Update driver assets
DriverLiabilities:Create	Create driver liabilities
DriverLiabilities:Delete	Delete driver liabilities
DriverLiabilities:Get	Get driver liabilities
DriverLiabilities:Update	Update driver liabilities
Drivers:Create	Create drivers
Drivers:Get	Get drivers
Drivers:Update	Update drivers
Events:Emit	Emit event
Events:Subscribe	Create event subscription, delete event subscription
Events:ReconcileSubscriptions	Reconcile event subscriptions
Events:GetTypes	Get event types
Events:ExecuteJob	Execute approval auto build claims event job, execute approval auto post claims event job
ExportTable	Export table
FinanceAssetTypes:Get	Get finance asset types
FinanceLiabilityTypes:Get	Get finance liability types
FinanceLiabilities:Get	Get finance liabilities
GNAF:GetAddressRecord	Get geocoded national address record
GNAF:AutocompleteAddressRecord	Autocomplete geocoded national address
ImportTable	Import table
InterfaceSalesforceLegacy:SyncQuote	Sync quote with Salesforce (legacy interface)
Mail:DeleteSuppressed	Delete suppressed destination
Mail:GetSuppressed	Get suppressed destination
Originators:Get	Get originators
OpportunityStages:Get	Get opportunity stages
Ping	Ping
Quote:Accept	Accept quote
Quotes:Copy	Copy quote
Quotes:GetChildQuotes	Get child quotes
Quotes:RenderPDF	Render quote PDF
Quotes:Update	Patch quote
QuoteVariants:Get	Get variants, get a list of variants, get variant profiles, get a list of variant profiles
Record:Upsert	Insert or update a record with auditing
SignonToken:Create	Create signon token
ReportQueries:Print	Print a report query
Suppliers:Create	Create suppliers
Suppliers:Get	Get suppliers
Suppliers:Update	Update supplier
WebServices	Create a quote (legacy), Get quote fields (legacy), Get quote PDF (legacy)

Action Buttons

Button	Description
View	Click to view the permissions available to be run by this role
Edit	Click to edit the permissions available to be run by this role
Save	When you have finished editing, click to save
Cancel	Click to discard your current changes

Legend

Permission - The permission is available by default
Permission (Restricted) - This permission is not visible on the Roles / APIs screen unless it has been configured for external use. Contact your Account Manager to discuss