Client_Initiations

Authenticate

auth

Sign In

The following routes are available for this service:
GET,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 ResponseStatus: ResponseStatus;

    // @DataMember(Order=13)
    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); }
}

TypeScript Authenticate DTOs

To override the Content-type in your clients, use the HTTP Accept Header, append the .jsv suffix or ?format=jsv

HTTP + 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: initiation-test.sirva.com 
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
	],
	ResponseStatus: 
	{
		ErrorCode: String,
		Message: String,
		StackTrace: String,
		Errors: 
		[
			{
				ErrorCode: String,
				FieldName: String,
				Message: String,
				Meta: 
				{
					String: String
				}
			}
		],
		Meta: 
		{
			String: String
		}
	},
	Meta: 
	{
		String: String
	}
}