GET /link
Making an Authorization Request
Last updated
Making an Authorization Request
Last updated
GET https://auth.open-utilities.com/v1/link
| Name | Type | Description |
|---|---|---|
| scope | Description |
|---|---|
The includeProviders, excludeProvider and providerCode field can be used together to limit the providers presented to the end user or eliminate the choice altogether.
Additionally, the following pseudo providers code can be specified:
gb-gas
gb-electricity
gb-water
gb-streaming
gb-tv
gb-broadband
gb-landline
gb-mobile
gb-insurance
302 redirect to the link
client_id
string
The client_id allocated to your application
response_type
string
Must be code
scope
string
See table below.
redirect_uri
optional string
Must match one of those configured for your application
state
optional string
Recommended. Passed back with the redirect
code_challenge
optional string
Required where PKCE is mandatory.
code_challenge_method
optional string
Required where PKCE is mandatory. Must be one of plain or S256
includeProviders
optional string
Space separated list of provider codes for providers to present to the user
excludeProviders
optional string
Space separated list of provider codes for providers to exclude from the selection screen
providerCode
optional string
If set then the provider selection screen is skipped entirely
plan
documents
offline_access