Repository: incubator-milagro-mfa-sdk-core Updated Branches: refs/heads/master 807c2938c -> 4eeaf551e
Update documentation for `GetServiceDetails()` Project: http://git-wip-us.apache.org/repos/asf/incubator-milagro-mfa-sdk-core/repo Commit: http://git-wip-us.apache.org/repos/asf/incubator-milagro-mfa-sdk-core/commit/4eeaf551 Tree: http://git-wip-us.apache.org/repos/asf/incubator-milagro-mfa-sdk-core/tree/4eeaf551 Diff: http://git-wip-us.apache.org/repos/asf/incubator-milagro-mfa-sdk-core/diff/4eeaf551 Branch: refs/heads/master Commit: 4eeaf551e66fce455b93c8904ca7f353a9e05b09 Parents: 807c293 Author: Simeon Aladjem <[email protected]> Authored: Thu Dec 15 12:22:54 2016 +0200 Committer: Simeon Aladjem <[email protected]> Committed: Thu Dec 15 12:22:54 2016 +0200 ---------------------------------------------------------------------- README.md | 21 +++++++++++++++++++++ 1 file changed, 21 insertions(+) ---------------------------------------------------------------------- http://git-wip-us.apache.org/repos/asf/incubator-milagro-mfa-sdk-core/blob/4eeaf551/README.md ---------------------------------------------------------------------- diff --git a/README.md b/README.md index 6246881..b927b49 100644 --- a/README.md +++ b/README.md @@ -337,6 +337,27 @@ The method will return `Status::OK` on success and `Status::FLOW_ERROR` if the S This method will populate the provided vector with all the backends known to the SDK. The method will return `Status::OK` on success and `Status::FLOW_ERROR` if the SDK was not initialized. +##### `Status GetServiceDetails(const String& url, OUT ServiceDetails& serviceDetails);` +This method is provided for applications working with the _MIRACL MFA Platform_. +After scanning a QR Code from the platform login page, the app should extract the URL from it and call this method to retreive the service details. +The service details include the _backend URL_ which needs to be set back to the SDK in order connect it to the platform. +This method could be called even before the SDK has been initialized, or alternatively the SDK could be initialized without setting a backend, and `SetBackend()` could be used after the backend URL has been retreived through this method. +The returned `ServiceDetails` look as follows: +```c++ +class ServiceDetails +{ +public: + String name; + String backendUrl; + String rpsPrefix; + String logoUrl; +}; +``` +* `name` is the service readable name +* `backendUrl` is the URL of the service backend. This URL has to be set either via the SDK `Init()` method or using `SetBackend()` +* `rpsPrefix` is RPS prefix setting which is also provided together with `backendUrl` while setting a backend +* `logoUrl` is the URL of the service logo. The logo is a UI element that could be used by the app. + ##### `Status GetSessionDetails(const String& accessCode, OUT SessionDetails& sessionDetails);` This method could be optionally used to retrieve details regarding a browser session when the SDK is used to authenticate users to an online service, such as the _MIRACL MFA Platform_. In this case an `accessCode` is transferred to the mobile device out-of-band e.g. via scanning a graphical code.
