DX STF Client API

GetAuthToken

Auth Requests

Auth

The following routes are available for this service:
POST	/api/authentication/token	Get Bearer access token, contact support for credentials

namespace DX.STF.Application.ClientApi.Messages.Authentication

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

    [<AllowNullLiteral>]
    type AccessTokenResponse() = 
        member val AccessToken:String = null with get,set
        member val Scope:String = null with get,set
        member val TokenType:String = null with get,set
        member val ExpiresIn:Int32 = new Int32() with get,set
        member val HttpStatusCode:Int32 = new Int32() with get,set
        member val HttpErrorReason:String = null with get,set
        member val Error:String = null with get,set

    ///<summary>
    ///Auth
    ///</summary>
    [<Api(Description="Auth")>]
    [<ApiResponse(Description="Access token response", IsDefaultResponse=true, StatusCode=200)>]
    [<AllowNullLiteral>]
    type GetAuthToken() = 
        ///<summary>
        ///Post parameters in body
        ///</summary>
        [<ApiMember(Description="Post parameters in body", ParameterType="model")>]
        member val ClientId:String = null with get,set

        ///<summary>
        ///Post parameters in body
        ///</summary>
        [<ApiMember(Description="Post parameters in body", ParameterType="model")>]
        member val ClientSecret:String = null with get,set

        ///<summary>
        ///Post parameters in body
        ///</summary>
        [<ApiMember(Description="Post parameters in body", ParameterType="model")>]
        member val Scope:String = null with get,set

F# GetAuthToken DTOs

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

HTTP + JSV

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

POST /api/authentication/token HTTP/1.1 
Host: stf-api-uat.data-xchange.co.za 
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length

{
	clientId: String,
	clientSecret: String,
	scope: String
}

HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length

{
	accessToken: String,
	scope: String,
	tokenType: String,
	expiresIn: 0,
	httpStatusCode: 0,
	httpErrorReason: String,
	error: String
}