 | IOAuthClientAuthenticateUser Method |
Authenticate a user given an authenticated device principal and optionally a specific application.
Namespace: SanteDB.Client.ServicesAssembly: SanteDB.Client (in SanteDB.Client.dll) Version: 3.0.2081-alpha+027e4605b77f83de5445cbcd55717223932d2452
SyntaxIClaimsPrincipal AuthenticateUser(
string username,
string password,
string clientId = null,
string tfaSecret = null,
IEnumerable<IClaim> clientClaimAssertions = null,
IEnumerable<string> scopes = null
)
Function AuthenticateUser (
username As String,
password As String,
Optional clientId As String = Nothing,
Optional tfaSecret As String = Nothing,
Optional clientClaimAssertions As IEnumerable(Of IClaim) = Nothing,
Optional scopes As IEnumerable(Of String) = Nothing
) As IClaimsPrincipal
IClaimsPrincipal^ AuthenticateUser(
String^ username,
String^ password,
String^ clientId = nullptr,
String^ tfaSecret = nullptr,
IEnumerable<IClaim^>^ clientClaimAssertions = nullptr,
IEnumerable<String^>^ scopes = nullptr
)
abstract AuthenticateUser :
username : string *
password : string *
?clientId : string *
?tfaSecret : string *
?clientClaimAssertions : IEnumerable<IClaim> *
?scopes : IEnumerable<string>
(* Defaults:
let _clientId = defaultArg clientId null
let _tfaSecret = defaultArg tfaSecret null
let _clientClaimAssertions = defaultArg clientClaimAssertions null
let _scopes = defaultArg scopes null
*)
-> IClaimsPrincipal Parameters
- username String
- The username to pass to the OAUTH service
- password String
- The password to pass to the OAUTH service
- clientId String (Optional)
- Optional client_id to provide in the request. If this value is null, the Realm client_id will be used.
- tfaSecret String (Optional)
- The MFA secret collected from the user
- clientClaimAssertions IEnumerableIClaim (Optional)
- Claims which are to be provided on the OAUTH request
- scopes IEnumerableString (Optional)
- Scopes that should be appended
Return Value
IClaimsPrincipalThe claims principal if the session was authenticated
See Also