/support/external-api-clients

Body Params

name

string | null

allowedEndpoints

array of strings | null

Entries formatted as "{HTTP method} {route template}", e.g. "GET netevia/profile".

allowedEndpoints

allowedBankingStatuses

array of objects | null

allowedBankingStatuses

allowedTargetBankingStatuses

array of objects | null

NB-3691: statuses this client may set through POST external/profile/changeBankingStatus.
Separate from Banking.Models.ExternalApi.CreateExternalApiClientRequest.AllowedBankingStatuses, which only says what it may read.
Optional - omitted or empty leaves the client read-only. AutoApprovedUW is refused.

allowedTargetBankingStatuses

allowUnmaskedSsn

boolean

NB-3677. Stored on the client's service account as
UserProfile.CanViewUnmaskedSsn, not on the client row, so the permission is
read fresh on every request and is expressible for any account type. Off by default.

requestsPerMinute

int32

Headers

string

enum

Defaults to application/json

Generated from available response content types

Allowed:

content-type

string

enum

Defaults to application/json

Generated from available request content types

Allowed:

200Success