OPTIONS,GET,POST,DELETE | /auth | ||
---|---|---|---|
OPTIONS,GET,POST,DELETE | /auth/{provider} |
"use strict";
export class AuthenticateResponse {
/** @param {{userId?:string,sessionId?:string,userName?:string,displayName?:string,referrerUrl?:string,bearerToken?:string,refreshToken?:string,profileUrl?:string,roles?:string[],permissions?:string[],responseStatus?:ResponseStatus,meta?:{ [index: string]: string; }}} [init] */
constructor(init) { Object.assign(this, init) }
/** @type {string} */
userId;
/** @type {string} */
sessionId;
/** @type {string} */
userName;
/** @type {string} */
displayName;
/** @type {string} */
referrerUrl;
/** @type {string} */
bearerToken;
/** @type {string} */
refreshToken;
/** @type {string} */
profileUrl;
/** @type {string[]} */
roles;
/** @type {string[]} */
permissions;
/** @type {ResponseStatus} */
responseStatus;
/** @type {{ [index: string]: string; }} */
meta;
}
export class Authenticate {
/** @param {{provider?:string,state?:string,oauth_token?:string,oauth_verifier?:string,userName?:string,password?:string,rememberMe?:boolean,errorView?:string,nonce?:string,uri?:string,response?:string,qop?:string,nc?:string,cnonce?:string,accessToken?:string,accessTokenSecret?:string,scope?:string,returnUrl?:string,meta?:{ [index: string]: string; }}} [init] */
constructor(init) { Object.assign(this, init) }
/**
* @type {string}
* @description AuthProvider, e.g. credentials */
provider;
/** @type {string} */
state;
/** @type {string} */
oauth_token;
/** @type {string} */
oauth_verifier;
/** @type {string} */
userName;
/** @type {string} */
password;
/** @type {?boolean} */
rememberMe;
/** @type {string} */
errorView;
/** @type {string} */
nonce;
/** @type {string} */
uri;
/** @type {string} */
response;
/** @type {string} */
qop;
/** @type {string} */
nc;
/** @type {string} */
cnonce;
/** @type {string} */
accessToken;
/** @type {string} */
accessTokenSecret;
/** @type {string} */
scope;
/** @type {string} */
returnUrl;
/** @type {{ [index: string]: string; }} */
meta;
}
To override the Content-type in your clients, use the HTTP Accept Header, append the .json suffix or ?format=json
To embed the response in a jsonp callback, append ?callback=myCallback
The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.
POST /auth HTTP/1.1
Host: test.servicestack.net
Accept: application/json
Content-Type: application/json
Content-Length: length
{"provider":"String","state":"String","oauth_token":"String","oauth_verifier":"String","userName":"String","password":"String","rememberMe":false,"errorView":"String","nonce":"String","uri":"String","response":"String","qop":"String","nc":"String","cnonce":"String","accessToken":"String","accessTokenSecret":"String","scope":"String","returnUrl":"String","meta":{"String":"String"}}
HTTP/1.1 200 OK Content-Type: application/json Content-Length: length {"userId":"String","sessionId":"String","userName":"String","displayName":"String","referrerUrl":"String","bearerToken":"String","refreshToken":"String","profileUrl":"String","roles":["String"],"permissions":["String"],"responseStatus":{"errorCode":"String","message":"String","stackTrace":"String","errors":[{"errorCode":"String","fieldName":"String","message":"String","meta":{"String":"String"}}],"meta":{"String":"String"}},"meta":{"String":"String"}}