POST | /auth/{provider} | ||
---|---|---|---|
GET,POST | /auth |
import 'package:servicestack/servicestack.dart';
import 'dart:typed_data';
// @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)
String? authProvider;
// @DataMember(Order=13)
ResponseStatus? responseStatus;
// @DataMember(Order=14)
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.authProvider,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!);
authProvider = json['authProvider'];
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!),
'authProvider': authProvider,
'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: 'blazor_gallery.servicestack.net', types: <String, TypeInfo> {
});
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 /auth/{provider} HTTP/1.1
Host: blazor-gallery.servicestack.net
Accept: application/xml
Content-Type: application/xml
Content-Length: length
<Authenticate xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.servicestack.net/types">
<provider>String</provider>
<UserName>String</UserName>
<Password>String</Password>
<RememberMe>false</RememberMe>
<AccessToken>String</AccessToken>
<AccessTokenSecret>String</AccessTokenSecret>
<ReturnUrl>String</ReturnUrl>
<ErrorView>String</ErrorView>
<Meta xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d2p1:KeyValueOfstringstring>
<d2p1:Key>String</d2p1:Key>
<d2p1:Value>String</d2p1:Value>
</d2p1:KeyValueOfstringstring>
</Meta>
</Authenticate>
HTTP/1.1 200 OK Content-Type: application/xml Content-Length: length <AuthenticateResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.servicestack.net/types"> <UserId>String</UserId> <SessionId>String</SessionId> <UserName>String</UserName> <DisplayName>String</DisplayName> <ReferrerUrl>String</ReferrerUrl> <BearerToken>String</BearerToken> <RefreshToken>String</RefreshToken> <RefreshTokenExpiry>0001-01-01T00:00:00</RefreshTokenExpiry> <ProfileUrl>String</ProfileUrl> <Roles xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays"> <d2p1:string>String</d2p1:string> </Roles> <Permissions xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays"> <d2p1:string>String</d2p1:string> </Permissions> <AuthProvider>String</AuthProvider> <ResponseStatus> <ErrorCode>String</ErrorCode> <Message>String</Message> <StackTrace>String</StackTrace> <Errors> <ResponseError> <ErrorCode>String</ErrorCode> <FieldName>String</FieldName> <Message>String</Message> <Meta xmlns:d5p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays"> <d5p1:KeyValueOfstringstring> <d5p1:Key>String</d5p1:Key> <d5p1:Value>String</d5p1:Value> </d5p1:KeyValueOfstringstring> </Meta> </ResponseError> </Errors> <Meta xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays"> <d3p1:KeyValueOfstringstring> <d3p1:Key>String</d3p1:Key> <d3p1:Value>String</d3p1:Value> </d3p1:KeyValueOfstringstring> </Meta> </ResponseStatus> <Meta xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays"> <d2p1:KeyValueOfstringstring> <d2p1:Key>String</d2p1:Key> <d2p1:Value>String</d2p1:Value> </d2p1:KeyValueOfstringstring> </Meta> </AuthenticateResponse>