mirrors/flexisip-account-manager
1
0
Fork 0
mirror of https://gitlab.linphone.org/BC/public/flexisip-account-manager.git synced 2026-01-17 01:58:07 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions

Fix FLEXIAPI-371 Add documentation for the Wizard page

Browse source
This commit is contained in:
Timothée Jaussoin 2025-08-18 16:55:13 +02:00
parent a876a8cf82
commit 9a9b8ab34e
3 changed files with 14 additions and 5 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

1
CHANGELOG.md
View file

@ -3,6 +3,7 @@
v2.1
----
- Fix FLEXIAPI-282 Migrate to Laravel 11 and PHP 8.2+
- Fix FLEXIAPI-371 Add documentation for the Wizard page
v2.0
----

4
flexiapi/resources/views/admin/account/provisioning_email/create.blade.php
View file

@ -3,13 +3,13 @@
@section('breadcrumb')
@include('admin.account.parts.breadcrumb_accounts_index')
@include('admin.account.parts.breadcrumb_accounts_show', ['account' => $account])
<li class="breadcrumb-item active" aria-current="page">{{ __('Reset password') }}</li>
<li class="breadcrumb-item active" aria-current="page">{{ __('Provisioning') }}</li>
@endsection
@section('content')
<header>
<h1><i class="ph ph-envelope"></i> {{ __('Reset password') }}</h1>
<h1><i class="ph ph-envelope"></i> {{ __('Provisioning') }}</h1>
</header>
<p>{{ __('An email will be sent to :email with a QR Code and provisioning link.', ['email' => $account->email]) }}</p>

14
flexiapi/resources/views/provisioning/documentation_markdown.blade.php
View file

@ -12,7 +12,7 @@ To request the following URLs client MUST add a specific `x-linphone-provisionin
Otherwise the URLs with always return 400. This specific header is required to prevent unsolicited clients (crawlers, embedders) to consume the tokens.
```
> GET /provisioning/###
> GET /provisioning/{provisioning_token}
> x-linphone-provisioning
```
@ -31,17 +31,25 @@ A provisioning content example
The general idea is to allow the clients to access a unique URL returning a custom XML file containing the following elements:
* <span class="badge badge-success">Public</span> Expose the linphonerc INI file configuration
* <span class="badge badge-success">Public</span> Expose the main Linphone RC configuration
* <span class="badge badge-info">User</span> Inject the authentication information to allow the application to authenticate on the server directly if a valid account is detected using the `provisioning` token
* <span class="badge badge-success">Public</span> <span class="badge badge-info">User</span> Using __Custom Hooks__ an admin is also able to have access to the authenticated User internal object and inject custom XML during the provisioning. See the specific section in the `README.md` to learn more about that feature.
### Features
When scanning a provisioning URL with a valid token the server is also:
When querying a provisioning URL with a valid token the server is also:
* <span class="badge badge-info">User</span> Activating the account
* <span class="badge badge-info">User</span> Reseting the password, generating the new authentication information and returning them (if the `reset_password` parameter is present)
## Wizard
### `GET /wizard/{provisioning_token}`
<span class="badge badge-success">Public</span>
Return a wizard page allowing a user to open Linphone with a `linphone-config` link pointing to a provisioning link having the provided `provisioning_token`.
## Endpoints
When an account is having an available `provisioning_token` it can be provisioned using the following URLs.