DX STF Client API

<back to all web services

GetAuthToken

Auth Requests

Auth

The following routes are available for this service:
POST/api/authentication/tokenGet Bearer access token, contact support for credentials
import java.math.*
import java.util.*
import java.io.InputStream
import net.servicestack.client.*


/**
* Auth
*/
@Api(Description="Auth")
@ApiResponse(Description="Access token response", IsDefaultResponse=true, StatusCode=200)
open class GetAuthToken
{
    /**
    * Post parameters in body
    */
    @ApiMember(Description="Post parameters in body", ParameterType="model")
    open var clientId:String? = null

    /**
    * Post parameters in body
    */
    @ApiMember(Description="Post parameters in body", ParameterType="model")
    open var clientSecret:String? = null

    /**
    * Post parameters in body
    */
    @ApiMember(Description="Post parameters in body", ParameterType="model")
    open var scope:String? = null
}

open class AccessTokenResponse
{
    open var accessToken:String? = null
    open var scope:String? = null
    open var tokenType:String? = null
    open var expiresIn:Int? = null
    open var httpStatusCode:Int? = null
    open var httpErrorReason:String? = null
    open var error:String? = null
}

Kotlin GetAuthToken DTOs

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

HTTP + OTHER

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/jsonl
Content-Type: text/jsonl
Content-Length: length

{"clientId":"String","clientSecret":"String","scope":"String"}
HTTP/1.1 200 OK
Content-Type: text/jsonl
Content-Length: length

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