API Client Registration#

The OAuth client registrations for the eduVPN and Let’s Connect! applications are hard-coded. The full list can be found here.

In vpn-user-portal > 3.3.0 it is possible to add your own OAuth API client registration.

This is done by creating a JSON file in /etc/vpn-user-portal/oauth_client_db.json.

The format is an array with objects. See the full example below.

NOTE: from vpn-user-portal >= 3.4.0 you SHOULD define the scope field with the value config to restrict the scope the VPN client can request.

Format#

The object supports the following fields / types:

Field	Required	Type	Default	Example
`client_id`	Yes	`string`	N/A	`my-client-id`
`redirect_uris`	Yes	`string[]`	N/A	`["https://app.example.org/callback"]`
`client_secret`	No	`string`	N/A	`s3cr3t`
`client_name`	No	`string`	value of `client_id`	`My Application`
`requires_approval`	No	`bool`	`true`	`false`
`scope`	No	`string`	N/A	`config`

Example#

As an example we’ll list the govVPN OAuth client registrations here. This would be the full contents of /etc/vpn-user-portal/oauth_client_db.json:

[
    {
        "client_id": "org.govvpn.app.windows",
        "client_name": "govVPN for Windows",
        "redirect_uris": [
            "http://127.0.0.1:{PORT}/callback",
            "http://[::1]:{PORT}/callback"
        ],
        "scope": "config"
    },
    {
        "client_id": "org.govvpn.app.android",
        "client_name": "govVPN for Android",
        "redirect_uris": [
            "org.govvpn.app:/api/callback",
            "org.govvpn.app.android:/api/callback"
        ],
        "scope": "config"
    },
    {
        "client_id": "org.govvpn.app.ios",
        "client_name": "govVPN for iOS",
        "redirect_uris": [
            "org.govvpn.app.ios:/api/callback"
        ],
        "scope": "config"
    },
    {
        "client_id": "org.govvpn.app.macos",
        "client_name": "govVPN for macOS",
        "redirect_uris": [
            "http://127.0.0.1:{PORT}/callback",
            "http://[::1]:{PORT}/callback"
        ],
        "scope": "config"
    },
    {
        "client_id": "org.govvpn.app.linux",
        "client_name": "govVPN for Linux",
        "redirect_uris": [
            "http://127.0.0.1:{PORT}/callback",
            "http://[::1]:{PORT}/callback"
        ],
        "scope": "config"
    }
]