MyApp

<back to all web services

Authenticate

auth

Sign In

The following routes are available for this service:
GET,POST/auth/{provider}
GET,POST/auth
namespace ServiceStack

open System
open System.Collections
open System.Collections.Generic
open System.Runtime.Serialization
open ServiceStack
open ServiceStack.DataAnnotations

    [<DataContract>]
    [<AllowNullLiteral>]
    type AuthenticateResponse() = 
        [<DataMember(Order=1)>]
        member val UserId:String = null with get,set

        [<DataMember(Order=2)>]
        member val SessionId:String = null with get,set

        [<DataMember(Order=3)>]
        member val UserName:String = null with get,set

        [<DataMember(Order=4)>]
        member val DisplayName:String = null with get,set

        [<DataMember(Order=5)>]
        member val ReferrerUrl:String = null with get,set

        [<DataMember(Order=6)>]
        member val BearerToken:String = null with get,set

        [<DataMember(Order=7)>]
        member val RefreshToken:String = null with get,set

        [<DataMember(Order=8)>]
        member val RefreshTokenExpiry:Nullable<DateTime> = new Nullable<DateTime>() with get,set

        [<DataMember(Order=9)>]
        member val ProfileUrl:String = null with get,set

        [<DataMember(Order=10)>]
        member val Roles:ResizeArray<String> = new ResizeArray<String>() with get,set

        [<DataMember(Order=11)>]
        member val Permissions:ResizeArray<String> = new ResizeArray<String>() with get,set

        [<DataMember(Order=12)>]
        member val ResponseStatus:ResponseStatus = null with get,set

        [<DataMember(Order=13)>]
        member val Meta:Dictionary<String, String> = new Dictionary<String, String>() with get,set

    ///<summary>
    ///Sign In
    ///</summary>
    [<Api(Description="Sign In")>]
    [<DataContract>]
    [<AllowNullLiteral>]
    type Authenticate() = 
        interface IPost
        ///<summary>
        ///AuthProvider, e.g. credentials
        ///</summary>
        [<DataMember(Order=1)>]
        member val provider:String = null with get,set

        [<DataMember(Order=2)>]
        member val UserName:String = null with get,set

        [<DataMember(Order=3)>]
        member val Password:String = null with get,set

        [<DataMember(Order=4)>]
        member val RememberMe:Nullable<Boolean> = new Nullable<Boolean>() with get,set

        [<DataMember(Order=5)>]
        member val AccessToken:String = null with get,set

        [<DataMember(Order=6)>]
        member val AccessTokenSecret:String = null with get,set

        [<DataMember(Order=7)>]
        member val ReturnUrl:String = null with get,set

        [<DataMember(Order=8)>]
        member val ErrorView:String = null with get,set

        [<DataMember(Order=9)>]
        member val Meta:Dictionary<String, String> = new Dictionary<String, String>() with get,set

F# Authenticate DTOs

To override the Content-type in your clients, use the HTTP Accept Header, append the .other suffix or ?format=other

HTTP + OTHER

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

POST /auth/{provider} HTTP/1.1 
Host: vue-vite-api.jamstacks.net 
Accept: text/jsonl
Content-Type: text/jsonl
Content-Length: length

{"provider":"String","userName":"String","password":"String","rememberMe":false,"accessToken":"String","accessTokenSecret":"String","returnUrl":"String","errorView":"String","meta":{"String":"String"}}

HTTP/1.1 200 OK
Content-Type: text/jsonl
Content-Length: length

{"userId":"String","sessionId":"String","userName":"String","displayName":"String","referrerUrl":"String","bearerToken":"String","refreshToken":"String","refreshTokenExpiry":"\/Date(-62135596800000-0000)\/","profileUrl":"String","roles":["String"],"permissions":["String"],"responseStatus":{"errorCode":"String","message":"String","stackTrace":"String","errors":[{"errorCode":"String","fieldName":"String","message":"String","meta":{"String":"String"}}],"meta":{"String":"String"}},"meta":{"String":"String"}}