| 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
To override the Content-type in your clients, use the HTTP Accept Header, append the .xml suffix or ?format=xml
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: application/xml
Content-Type: application/xml
Content-Length: length
<GetAuthToken xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/DX.STF.Application.ClientApi.Messages.Authentication">
<ClientId>String</ClientId>
<ClientSecret>String</ClientSecret>
<Scope>String</Scope>
</GetAuthToken>
HTTP/1.1 200 OK Content-Type: application/xml Content-Length: length <AccessTokenResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/DX.STF.Application.ClientApi.ResponseMessages.Authentication"> <AccessToken>String</AccessToken> <Error>String</Error> <ExpiresIn>0</ExpiresIn> <HttpErrorReason>String</HttpErrorReason> <HttpStatusCode>0</HttpStatusCode> <Scope>String</Scope> <TokenType>String</TokenType> </AccessTokenResponse>