Evo Voice

<back to all web services

GetAuthStatus

Gets the current authenticated status or null

The following routes are available for this service:
GET/auth/status
namespace Voice.Api.Authentication

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

    type DashboardPermissions =
        | ViewFiles = 0
        | ViewNotifications = 1
        | ViewSessions = 2
        | ViewEndpoints = 3
        | ViewReports = 4
        | ViewCustomers = 5
        | ViewFlows = 6

    [<AllowNullLiteral>]
    type UserInfo() = 
        member val Id:String = null with get,set
        member val IsAuthenticated:Boolean = new Boolean() with get,set
        member val FirstName:String = null with get,set
        member val LastName:String = null with get,set
        member val Name:String = null with get,set
        member val AvatarUrl:String = null with get,set
        member val EmailAddress:String = null with get,set
        member val Roles:ResizeArray<String> = new ResizeArray<String>() with get,set
        member val AccountIds:ResizeArray<String> = new ResizeArray<String>() with get,set
        member val AccountNames:ResizeArray<String> = new ResizeArray<String>() with get,set
        member val DashboardPermissions:ResizeArray<DashboardPermissions> = new ResizeArray<DashboardPermissions>() with get,set

    ///<summary>
    ///Gets the current authenticated status or null
    ///</summary>
    [<Api(Description="Gets the current authenticated status or null")>]
    [<AllowNullLiteral>]
    type GetAuthStatus() = 
        interface IGet

F# GetAuthStatus DTOs

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

To embed the response in a jsonp callback, append ?callback=myCallback

HTTP + JSON

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

GET /auth/status HTTP/1.1 
Host: evovoice.io 
Accept: application/json

HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: length

{"id":"String","isAuthenticated":false,"firstName":"String","lastName":"String","name":"String","avatarUrl":"String","emailAddress":"String","roles":["String"],"accountIds":["String"],"accountNames":["String"],"dashboardPermissions":["ViewFiles"]}