Reporting Services

<back to all web services

Authenticate

auth

Sign In

The following routes are available for this service:
OPTIONS,GET,POST,DELETE/auth
OPTIONS,GET,POST,DELETE/auth/{provider}
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 ProfileUrl:String = null with get,set

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

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

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

        [<DataMember(Order=12)>]
        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 State:String = null with get,set

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

        [<DataMember(Order=20)>]
        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 .csv suffix or ?format=csv

HTTP + CSV

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

POST /auth HTTP/1.1 
Host: cip-reporting.chargeitpro.com 
Accept: text/csv
Content-Type: text/csv
Content-Length: length

{"provider":"String","State":"String","oauth_token":"String","oauth_verifier":"String","UserName":"String","Password":"String","RememberMe":false,"ErrorView":"String","nonce":"String","uri":"String","response":"String","qop":"String","nc":"String","cnonce":"String","AccessToken":"String","AccessTokenSecret":"String","scope":"String","Meta":{"String":"String"}}
HTTP/1.1 200 OK
Content-Type: text/csv
Content-Length: length

{"UserId":"String","SessionId":"String","UserName":"String","DisplayName":"String","ReferrerUrl":"String","BearerToken":"String","RefreshToken":"String","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"}}