ASH.ResourceLibrary.WebApi

<back to all web services

Authenticate

auth

Sign In

The following routes are available for this service:
All Verbs/authenticate
All Verbs/authenticate/{provider}
All Verbs/auth
All Verbs/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)>]
        [<ApiMember(Description="AuthProvider, e.g. credentials")>]
        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 .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.

POST /authenticate HTTP/1.1 
Host: resourcelibrary.api.ashcompanies.com 
Accept: application/xml
Content-Type: application/xml
Content-Length: length

<Authenticate xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.servicestack.net/types">
  <provider>String</provider>
  <State>String</State>
  <oauth_token>String</oauth_token>
  <oauth_verifier>String</oauth_verifier>
  <UserName>String</UserName>
  <Password>String</Password>
  <RememberMe>false</RememberMe>
  <ErrorView>String</ErrorView>
  <nonce>String</nonce>
  <uri>String</uri>
  <response>String</response>
  <qop>String</qop>
  <nc>String</nc>
  <cnonce>String</cnonce>
  <AccessToken>String</AccessToken>
  <AccessTokenSecret>String</AccessTokenSecret>
  <scope>String</scope>
  <Meta xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:KeyValueOfstringstring>
      <d2p1:Key>String</d2p1:Key>
      <d2p1:Value>String</d2p1:Value>
    </d2p1:KeyValueOfstringstring>
  </Meta>
</Authenticate>

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

<AuthenticateResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.servicestack.net/types">
  <UserId>String</UserId>
  <SessionId>String</SessionId>
  <UserName>String</UserName>
  <DisplayName>String</DisplayName>
  <ReferrerUrl>String</ReferrerUrl>
  <BearerToken>String</BearerToken>
  <RefreshToken>String</RefreshToken>
  <ProfileUrl>String</ProfileUrl>
  <Roles xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>String</d2p1:string>
  </Roles>
  <Permissions xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>String</d2p1:string>
  </Permissions>
  <ResponseStatus>
    <ErrorCode>String</ErrorCode>
    <Message>String</Message>
    <StackTrace>String</StackTrace>
    <Errors>
      <ResponseError>
        <ErrorCode>String</ErrorCode>
        <FieldName>String</FieldName>
        <Message>String</Message>
        <Meta xmlns:d5p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
          <d5p1:KeyValueOfstringstring>
            <d5p1:Key>String</d5p1:Key>
            <d5p1:Value>String</d5p1:Value>
          </d5p1:KeyValueOfstringstring>
        </Meta>
      </ResponseError>
    </Errors>
    <Meta xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:KeyValueOfstringstring>
        <d3p1:Key>String</d3p1:Key>
        <d3p1:Value>String</d3p1:Value>
      </d3p1:KeyValueOfstringstring>
    </Meta>
  </ResponseStatus>
  <Meta xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:KeyValueOfstringstring>
      <d2p1:Key>String</d2p1:Key>
      <d2p1:Value>String</d2p1:Value>
    </d2p1:KeyValueOfstringstring>
  </Meta>
</AuthenticateResponse>