OPTIONS,GET,POST,DELETE | /auth | ||
---|---|---|---|
OPTIONS,GET,POST,DELETE | /auth/{provider} |
// @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 profileUrl: string;
// @DataMember(Order=9)
public roles: string[];
// @DataMember(Order=10)
public permissions: string[];
// @DataMember(Order=11)
public responseStatus: ResponseStatus;
// @DataMember(Order=12)
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 state: string;
// @DataMember(Order=3)
public oauth_token: string;
// @DataMember(Order=4)
public oauth_verifier: string;
// @DataMember(Order=5)
public userName: string;
// @DataMember(Order=6)
public password: string;
// @DataMember(Order=7)
public rememberMe?: boolean;
// @DataMember(Order=9)
public errorView: string;
// @DataMember(Order=10)
public nonce: string;
// @DataMember(Order=11)
public uri: string;
// @DataMember(Order=12)
public response: string;
// @DataMember(Order=13)
public qop: string;
// @DataMember(Order=14)
public nc: string;
// @DataMember(Order=15)
public cnonce: string;
// @DataMember(Order=17)
public accessToken: string;
// @DataMember(Order=18)
public accessTokenSecret: string;
// @DataMember(Order=19)
public scope: string;
// @DataMember(Order=20)
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 .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 HTTP/1.1
Host: apps.harbourassist.com
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>
<State>String</State>
<oauth_token>String</oauth_token>
<oauth_verifier>String</oauth_verifier>
<UserName>String</UserName>
<Password>String</Password>
<RememberMe>false</RememberMe>
<ErrorView>String</ErrorView>
<nonce>String</nonce>
<uri>String</uri>
<response>String</response>
<qop>String</qop>
<nc>String</nc>
<cnonce>String</cnonce>
<AccessToken>String</AccessToken>
<AccessTokenSecret>String</AccessTokenSecret>
<scope>String</scope>
<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> <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>