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}
using System;
using System.Collections;
using System.Collections.Generic;
using System.Runtime.Serialization;
using ServiceStack;
using ServiceStack.DataAnnotations;

namespace ServiceStack
{
    ///<summary>
    ///Sign In
    ///</summary>
    [Api(Description="Sign In")]
    [DataContract]
    public partial class Authenticate
        : IPost, IMeta
    {
        public Authenticate()
        {
            Meta = new Dictionary<string, string>{};
        }

        ///<summary>
        ///AuthProvider, e.g. credentials
        ///</summary>
        [DataMember(Order=1)]
        public virtual string provider { get; set; }

        [DataMember(Order=2)]
        public virtual string State { get; set; }

        [DataMember(Order=3)]
        public virtual string oauth_token { get; set; }

        [DataMember(Order=4)]
        public virtual string oauth_verifier { get; set; }

        [DataMember(Order=5)]
        public virtual string UserName { get; set; }

        [DataMember(Order=6)]
        public virtual string Password { get; set; }

        [DataMember(Order=7)]
        public virtual bool? RememberMe { get; set; }

        [DataMember(Order=9)]
        public virtual string ErrorView { get; set; }

        [DataMember(Order=10)]
        public virtual string nonce { get; set; }

        [DataMember(Order=11)]
        public virtual string uri { get; set; }

        [DataMember(Order=12)]
        public virtual string response { get; set; }

        [DataMember(Order=13)]
        public virtual string qop { get; set; }

        [DataMember(Order=14)]
        public virtual string nc { get; set; }

        [DataMember(Order=15)]
        public virtual string cnonce { get; set; }

        [DataMember(Order=17)]
        public virtual string AccessToken { get; set; }

        [DataMember(Order=18)]
        public virtual string AccessTokenSecret { get; set; }

        [DataMember(Order=19)]
        public virtual string scope { get; set; }

        [DataMember(Order=20)]
        public virtual Dictionary<string, string> Meta { get; set; }
    }

    [DataContract]
    public partial class AuthenticateResponse
        : IMeta, IHasSessionId, IHasBearerToken
    {
        public AuthenticateResponse()
        {
            Roles = new List<string>{};
            Permissions = new List<string>{};
            Meta = new Dictionary<string, string>{};
        }

        [DataMember(Order=1)]
        public virtual string UserId { get; set; }

        [DataMember(Order=2)]
        public virtual string SessionId { get; set; }

        [DataMember(Order=3)]
        public virtual string UserName { get; set; }

        [DataMember(Order=4)]
        public virtual string DisplayName { get; set; }

        [DataMember(Order=5)]
        public virtual string ReferrerUrl { get; set; }

        [DataMember(Order=6)]
        public virtual string BearerToken { get; set; }

        [DataMember(Order=7)]
        public virtual string RefreshToken { get; set; }

        [DataMember(Order=8)]
        public virtual string ProfileUrl { get; set; }

        [DataMember(Order=9)]
        public virtual List<string> Roles { get; set; }

        [DataMember(Order=10)]
        public virtual List<string> Permissions { get; set; }

        [DataMember(Order=11)]
        public virtual ResponseStatus ResponseStatus { get; set; }

        [DataMember(Order=12)]
        public virtual Dictionary<string, string> Meta { get; set; }
    }

}

C# 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"}}