MyHome.ie Data Delivery Service

Authenticate

The following routes are available for this service:
All Verbs	/auth
All Verbs	/auth/{provider}

**Authenticate** Parameters:
Name	Parameter	Data Type	Required
provider	path	string	No
State	query	string	No
oauth_token	query	string	No
oauth_verifier	query	string	No
UserName	query	string	No
Password	query	string	No
RememberMe	query	bool?	No
ErrorView	query	string	No
nonce	query	string	No
uri	query	string	No
response	query	string	No
qop	query	string	No
nc	query	string	No
cnonce	query	string	No
UseTokenCookie	query	bool?	No
AccessToken	query	string	No
AccessTokenSecret	query	string	No
scope	query	string	No
Meta	query	Dictionary<string, string>	No

**AuthenticateResponse** Parameters:
Name	Parameter	Data Type	Required
UserId	form	string	No
SessionId	form	string	No
UserName	form	string	No
DisplayName	form	string	No
ReferrerUrl	form	string	No
BearerToken	form	string	No
RefreshToken	form	string	No
ProfileUrl	form	string	No
Roles	form	List<string>	No
Permissions	form	List<string>	No
ResponseStatus	form	ResponseStatus	No
Meta	form	Dictionary<string, string>	No

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 HTTP/1.1 
Host: agentapi.myhome.ie 
Accept: application/json
Content-Type: application/json
Content-Length: length

{"provider":"String","State":"String","oauth_token":"String","oauth_verifier":"String","UserName":"String","Password":"String","RememberMe":false,"ErrorView":"String","nonce":"String","uri":"String","response":"String","qop":"String","nc":"String","cnonce":"String","UseTokenCookie":false,"AccessToken":"String","AccessTokenSecret":"String","scope":"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","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"}}