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
Imports System
Imports System.Collections
Imports System.Collections.Generic
Imports System.Runtime.Serialization
Imports ServiceStack
Imports ServiceStack.DataAnnotations
Imports Voice.Api.Authentication

Namespace Global

    Namespace Voice.Api.Authentication

        Public Enum DashboardPermissions
            ViewFiles
            ViewNotifications
            ViewSessions
            ViewEndpoints
            ViewReports
            ViewCustomers
            ViewFlows
        End Enum

        '''<Summary>
        '''Gets the current authenticated status or null
        '''</Summary>
        <Api(Description:="Gets the current authenticated status or null")>
        Public Partial Class GetAuthStatus
            Implements IGet
        End Class

        Public Partial Class UserInfo
            Public Sub New()
                Roles = New List(Of String)
                AccountIds = New List(Of String)
                AccountNames = New List(Of String)
                DashboardPermissions = New List(Of DashboardPermissions)
            End Sub

            Public Overridable Property Id As String
            Public Overridable Property IsAuthenticated As Boolean
            Public Overridable Property FirstName As String
            Public Overridable Property LastName As String
            Public Overridable Property Name As String
            Public Overridable Property AvatarUrl As String
            Public Overridable Property EmailAddress As String
            Public Overridable Property Roles As List(Of String)
            Public Overridable Property AccountIds As List(Of String)
            Public Overridable Property AccountNames As List(Of String)
            Public Overridable Property DashboardPermissions As List(Of DashboardPermissions)
        End Class
    End Namespace
End Namespace

VB.NET 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"]}