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
import Foundation
import ServiceStack

/**
* Gets the current authenticated status or null
*/
// @Api(Description="Gets the current authenticated status or null")
public class GetAuthStatus : IGet, Codable
{
    required public init(){}
}

public class UserInfo : Codable
{
    public var id:String?
    public var isAuthenticated:Bool?
    public var firstName:String?
    public var lastName:String?
    public var name:String?
    public var avatarUrl:String?
    public var emailAddress:String?
    public var roles:[String] = []
    public var accountIds:[String] = []
    public var accountNames:[String] = []
    public var dashboardPermissions:[DashboardPermissions] = []

    required public init(){}
}

public enum DashboardPermissions : String, Codable
{
    case ViewFiles
    case ViewNotifications
    case ViewSessions
    case ViewEndpoints
    case ViewReports
    case ViewCustomers
    case ViewFlows
}


Swift GetAuthStatus DTOs

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

HTTP + XML

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/xml
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<UserInfo xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Voice.Api.Authentication">
  <AccountIds xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>String</d2p1:string>
  </AccountIds>
  <AccountNames xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>String</d2p1:string>
  </AccountNames>
  <AvatarUrl>String</AvatarUrl>
  <DashboardPermissions>
    <DashboardPermissions>ViewFiles</DashboardPermissions>
  </DashboardPermissions>
  <EmailAddress>String</EmailAddress>
  <FirstName>String</FirstName>
  <Id>String</Id>
  <IsAuthenticated>false</IsAuthenticated>
  <LastName>String</LastName>
  <Name>String</Name>
  <Roles xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>String</d2p1:string>
  </Roles>
</UserInfo>