POST | /v1/login | Process GAS Authentication |
---|
"use strict";
/** @typedef {'Authenticated'|'NotAuthenticated'|'Error'} */
export var LoginStatus;
(function (LoginStatus) {
LoginStatus["Authenticated"] = "Authenticated"
LoginStatus["NotAuthenticated"] = "NotAuthenticated"
LoginStatus["Error"] = "Error"
})(LoginStatus || (LoginStatus = {}));
export class LoginResponse {
/** @param {{RedirectUrl?:string,IsAuthenticated?:boolean,UserToken?:string,UserId?:string,UserRoleId?:number[],DefaultRetailer?:string,LoginStatus?:LoginStatus,UserRoleRedirect?:string,DefaultVehicleType?:string,EntitlementGroup?:string[]}} [init] */
constructor(init) { Object.assign(this, init) }
/** @type {string} */
RedirectUrl;
/** @type {boolean} */
IsAuthenticated;
/** @type {string} */
UserToken;
/** @type {string} */
UserId;
/** @type {number[]} */
UserRoleId;
/** @type {string} */
DefaultRetailer;
/** @type {LoginStatus} */
LoginStatus;
/** @type {string} */
UserRoleRedirect;
/** @type {string} */
DefaultVehicleType;
/** @type {string[]} */
EntitlementGroup;
}
export class LoginRequest {
/** @param {{AuthCode?:string,ErrorCode?:string,ClientId?:string,Secret?:string,CallbackUrl?:string,RedirectUrl?:string}} [init] */
constructor(init) { Object.assign(this, init) }
/**
* @type {string}
* @description GAS AuthCode */
AuthCode;
/**
* @type {string}
* @description GAS ErrorCode */
ErrorCode;
/**
* @type {string}
* @description Client Id */
ClientId;
/**
* @type {string}
* @description Secret */
Secret;
/**
* @type {string}
* @description Callback Url */
CallbackUrl;
/**
* @type {string}
* @description Redirect Url */
RedirectUrl;
}
To override the Content-type in your clients, use the HTTP Accept Header, append the .csv suffix or ?format=csv
The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.
POST /v1/login HTTP/1.1
Host: prod-api-auth-mb-dhc.rapp-customers.co.uk
Accept: text/csv
Content-Type: text/csv
Content-Length: length
{"AuthCode":"String","ErrorCode":"String","ClientId":"String","Secret":"String","CallbackUrl":"String","RedirectUrl":"String"}
HTTP/1.1 200 OK Content-Type: text/csv Content-Length: length {"RedirectUrl":"String","IsAuthenticated":false,"UserToken":"String","UserId":"String","UserRoleId":[0],"DefaultRetailer":"String","LoginStatus":"Authenticated","UserRoleRedirect":"String","DefaultVehicleType":"String","EntitlementGroup":["String"]}