MyApp

Authenticate

auth

Sign In

The following routes are available for this service:
GET,POST	/auth/{provider}
GET,POST	/auth

import 'package:servicestack/servicestack.dart';

// @DataContract
class AuthenticateResponse implements IMeta, IHasSessionId, IHasBearerToken, IConvertible
{
    // @DataMember(Order=1)
    String? userId;

    // @DataMember(Order=2)
    String? sessionId;

    // @DataMember(Order=3)
    String? userName;

    // @DataMember(Order=4)
    String? displayName;

    // @DataMember(Order=5)
    String? referrerUrl;

    // @DataMember(Order=6)
    String? bearerToken;

    // @DataMember(Order=7)
    String? refreshToken;

    // @DataMember(Order=8)
    DateTime? refreshTokenExpiry;

    // @DataMember(Order=9)
    String? profileUrl;

    // @DataMember(Order=10)
    List<String>? roles;

    // @DataMember(Order=11)
    List<String>? permissions;

    // @DataMember(Order=12)
    ResponseStatus? responseStatus;

    // @DataMember(Order=13)
    Map<String,String?>? meta;

    AuthenticateResponse({this.userId,this.sessionId,this.userName,this.displayName,this.referrerUrl,this.bearerToken,this.refreshToken,this.refreshTokenExpiry,this.profileUrl,this.roles,this.permissions,this.responseStatus,this.meta});
    AuthenticateResponse.fromJson(Map<String, dynamic> json) { fromMap(json); }

    fromMap(Map<String, dynamic> json) {
        userId = json['userId'];
        sessionId = json['sessionId'];
        userName = json['userName'];
        displayName = json['displayName'];
        referrerUrl = json['referrerUrl'];
        bearerToken = json['bearerToken'];
        refreshToken = json['refreshToken'];
        refreshTokenExpiry = JsonConverters.fromJson(json['refreshTokenExpiry'],'DateTime',context!);
        profileUrl = json['profileUrl'];
        roles = JsonConverters.fromJson(json['roles'],'List<String>',context!);
        permissions = JsonConverters.fromJson(json['permissions'],'List<String>',context!);
        responseStatus = JsonConverters.fromJson(json['responseStatus'],'ResponseStatus',context!);
        meta = JsonConverters.toStringMap(json['meta']);
        return this;
    }

    Map<String, dynamic> toJson() => {
        'userId': userId,
        'sessionId': sessionId,
        'userName': userName,
        'displayName': displayName,
        'referrerUrl': referrerUrl,
        'bearerToken': bearerToken,
        'refreshToken': refreshToken,
        'refreshTokenExpiry': JsonConverters.toJson(refreshTokenExpiry,'DateTime',context!),
        'profileUrl': profileUrl,
        'roles': JsonConverters.toJson(roles,'List<String>',context!),
        'permissions': JsonConverters.toJson(permissions,'List<String>',context!),
        'responseStatus': JsonConverters.toJson(responseStatus,'ResponseStatus',context!),
        'meta': meta
    };

    getTypeName() => "AuthenticateResponse";
    TypeContext? context = _ctx;
}

/**
* Sign In
*/
// @Api(Description="Sign In")
// @DataContract
class Authenticate implements IPost, IMeta, IConvertible
{
    /**
    * AuthProvider, e.g. credentials
    */
    // @DataMember(Order=1)
    String? provider;

    // @DataMember(Order=2)
    String? userName;

    // @DataMember(Order=3)
    String? password;

    // @DataMember(Order=4)
    bool? rememberMe;

    // @DataMember(Order=5)
    String? accessToken;

    // @DataMember(Order=6)
    String? accessTokenSecret;

    // @DataMember(Order=7)
    String? returnUrl;

    // @DataMember(Order=8)
    String? errorView;

    // @DataMember(Order=9)
    Map<String,String?>? meta;

    Authenticate({this.provider,this.userName,this.password,this.rememberMe,this.accessToken,this.accessTokenSecret,this.returnUrl,this.errorView,this.meta});
    Authenticate.fromJson(Map<String, dynamic> json) { fromMap(json); }

    fromMap(Map<String, dynamic> json) {
        provider = json['provider'];
        userName = json['userName'];
        password = json['password'];
        rememberMe = json['rememberMe'];
        accessToken = json['accessToken'];
        accessTokenSecret = json['accessTokenSecret'];
        returnUrl = json['returnUrl'];
        errorView = json['errorView'];
        meta = JsonConverters.toStringMap(json['meta']);
        return this;
    }

    Map<String, dynamic> toJson() => {
        'provider': provider,
        'userName': userName,
        'password': password,
        'rememberMe': rememberMe,
        'accessToken': accessToken,
        'accessTokenSecret': accessTokenSecret,
        'returnUrl': returnUrl,
        'errorView': errorView,
        'meta': meta
    };

    getTypeName() => "Authenticate";
    TypeContext? context = _ctx;
}

TypeContext _ctx = TypeContext(library: 'vue_vite_api.jamstacks.net', types: <String, TypeInfo> {
});

Dart Authenticate DTOs

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

HTTP + JSON

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: vue-vite-api.jamstacks.net 
Accept: application/json
Content-Type: application/json
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: application/json
Content-Length: length

{"userId":"String","sessionId":"String","userName":"String","displayName":"String","referrerUrl":"String","bearerToken":"String","refreshToken":"String","refreshTokenExpiry":"\/Date(-62135596800000-0000)\/","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"}}