Role Configuration: APIs

Roles, menus, screen aliases, and system menus

APIs

The Roles / API tab is only shown for roles where "Access Type" is 'web-services'.
'web_services' is a standard role with this access.

Only 'admin' users can view this tab and enable/disable permissions.
Available permissions are listed in alphanumeric order over three columns.
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

FieldDescription
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
Clients:Create	createClients copyClient
Clients:Update	patchClient
Clients:Get	getClient
ClientCostCentres:Get	getClientCostCentres
ClientIndustries:Get	getClientIndustries
CompetitorMargins:Get	getCompetitorMargins
Contract:FundsCheck
ContractBilling:Edit
ContractBilling:Vary
ContractBudgets:Get
ContractBudgets:Insert
ContractBudgets:Update
ContractEvents:ChangeDriver	changeContractDriver - Change driver by creating a driver change event.
ContractEventActions:Get	getContractEventActions - Return a list of contract event actions.
ContractEventValues:Get	getContractEventValues - Return a list of contract event values.
ContractEventDescriptions:Get	getContractEventDescriptions - Return a list of contract event descriptions.
ContractEvents:Create	createContractEvents - Create non-process-oriented contract events.
DealTypes	getDealTypes
DriverAssets:Create
DriverAssets:Delete
DriverAssets:Get
DriverAssets:Update
DriverLiabilities:Create
DriverLiabilities:Delete
DriverLiabilities:Get
DriverLiabilities:Update
Drivers:Create	createDrivers
Drivers:Get
Drivers:Update
Events:Emit	emitEvent
Events:Subscribe	createEventSubscription deleteEventSubscription
Events:ReconcileSubscriptions	ReconcileEventSubscriptions
Events:GetTypes	getEventTypes
Events:ExecuteJob	spApprovalsAutoBuildClaimsEventJob spApprovalsAutoPostClaimsEventJob
ExportTable
FinanceAssetTypes:Get
FinanceLiabilityFinanciers:Get
FinanceLiabilityTypes:Get
GNAF:GetAddressRecord	getGeocodedNationalAddressRecord
GNAF:AutocompleteAddressRecord	autocompleteGeocodededNationalAddress
ImportTable
InterfaceSalesforceLegacy:SyncQuote	Sync quote with Salesforce (legacy) interface_interface)
Mail:Delete suppressed destination	deleteSuppressedDestination
Mail:Get suppressed destination	getSuppressedDestination
Originators:Get	getOriginators
OpportunityStages:Get	getOpportunityStages
Ping
Quote:Accept	acceptQuote
Quotes:Copy	copyQuote
Quotes:GetChildQuotes	getChildQuotes
Quotes:RenderPDF	Render Quote PDF
Quotes:Update	patchQuote
QuoteVariants:Get	getVariants Get a list of variants getVariantProfiles Get a list of variant profiles
Record:Upsert	Insert or update a record with auditing
SignonToken:Create
ReportQueries:Print	Print a report query
Suppliers:Create
Suppliers:Get
Suppliers:Update	Update supplier
WebServices	Create a quote (legacy) Get quote fields (legacy) Get quote pdf (legacy)

Action Buttons

ButtonDescription
View
**	Click to edit the permissions that are available to be run by this role.
Edit
**	When you have finished editing, click to save.
**	Click to discard your current changes.

Legend

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