| GET,POST | /auth/{provider} | ||
|---|---|---|---|
| GET,POST | /auth |
"use strict";
export class AuthenticateResponse {
/** @param {{userId?:string,sessionId?:string,userName?:string,displayName?:string,referrerUrl?:string,bearerToken?:string,refreshToken?:string,refreshTokenExpiry?: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} */
refreshTokenExpiry;
/** @type {string} */
profileUrl;
/** @type {string[]} */
roles;
/** @type {string[]} */
permissions;
/** @type {ResponseStatus} */
responseStatus;
/** @type {{ [index: string]: string; }} */
meta;
}
export class Authenticate {
/** @param {{provider?:string,userName?:string,password?:string,rememberMe?:boolean,accessToken?:string,accessTokenSecret?:string,returnUrl?:string,errorView?:string,meta?:{ [index: string]: string; }}} [init] */
constructor(init) { Object.assign(this, init) }
/**
* @type {string}
* @description AuthProvider, e.g. credentials */
provider;
/** @type {string} */
userName;
/** @type {string} */
password;
/** @type {?boolean} */
rememberMe;
/** @type {string} */
accessToken;
/** @type {string} */
accessTokenSecret;
/** @type {string} */
returnUrl;
/** @type {string} */
errorView;
/** @type {{ [index: string]: string; }} */
meta;
}
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: vue-vite-api.jamstacks.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>
<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>