POST | /auth/{provider} | ||
---|---|---|---|
GET,POST | /auth |
// @DataContract
export class AuthenticateResponse implements IMeta, IHasSessionId, IHasBearerToken
{
// @DataMember(Order=1)
public userId: string;
// @DataMember(Order=2)
public sessionId: string;
// @DataMember(Order=3)
public userName: string;
// @DataMember(Order=4)
public displayName: string;
// @DataMember(Order=5)
public referrerUrl: string;
// @DataMember(Order=6)
public bearerToken: string;
// @DataMember(Order=7)
public refreshToken: string;
// @DataMember(Order=8)
public refreshTokenExpiry?: string;
// @DataMember(Order=9)
public profileUrl: string;
// @DataMember(Order=10)
public roles: string[];
// @DataMember(Order=11)
public permissions: string[];
// @DataMember(Order=12)
public authProvider: string;
// @DataMember(Order=13)
public responseStatus: ResponseStatus;
// @DataMember(Order=14)
public meta: { [index:string]: string; };
public constructor(init?: Partial<AuthenticateResponse>) { (Object as any).assign(this, init); }
}
/** @description Sign In */
// @Api(Description="Sign In")
// @DataContract
export class Authenticate implements IPost, IMeta
{
/** @description AuthProvider, e.g. credentials */
// @DataMember(Order=1)
public provider: string;
// @DataMember(Order=2)
public userName: string;
// @DataMember(Order=3)
public password: string;
// @DataMember(Order=4)
public rememberMe?: boolean;
// @DataMember(Order=5)
public accessToken: string;
// @DataMember(Order=6)
public accessTokenSecret: string;
// @DataMember(Order=7)
public returnUrl: string;
// @DataMember(Order=8)
public errorView: string;
// @DataMember(Order=9)
public meta: { [index:string]: string; };
public constructor(init?: Partial<Authenticate>) { (Object as any).assign(this, init); }
}
To override the Content-type in your clients, use the HTTP Accept Header, append the .jsv suffix or ?format=jsv
The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.
POST /auth/{provider} HTTP/1.1
Host: techstacks.io
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length
{
provider: String,
userName: String,
password: String,
rememberMe: False,
accessToken: String,
accessTokenSecret: String,
returnUrl: String,
errorView: String,
meta:
{
String: String
}
}
HTTP/1.1 200 OK Content-Type: text/jsv Content-Length: length { userId: String, sessionId: String, userName: String, displayName: String, referrerUrl: String, bearerToken: String, refreshToken: String, refreshTokenExpiry: 0001-01-01, profileUrl: String, roles: [ String ], permissions: [ String ], authProvider: String, responseStatus: { errorCode: String, message: String, stackTrace: String, errors: [ { errorCode: String, fieldName: String, message: String, meta: { String: String } } ], meta: { String: String } }, meta: { String: String } }