DigiOffice Gateway Web Services

Authenticate

auth

Sign In

The following routes are available for this service:
OPTIONS,GET,POST,DELETE	/api/auth
OPTIONS,GET,POST,DELETE	/api/auth/{provider}
OPTIONS,GET,POST,DELETE	/api/authenticate
OPTIONS,GET,POST,DELETE	/api/authenticate/{provider}

**Authenticate** Parameters:
Name	Parameter	Data Type	Required	Description
provider	path	string	No	AuthProvider, e.g. credentials
State	body	string	No
oauth_token	body	string	No
oauth_verifier	body	string	No
UserName	body	string	No
Password	body	string	No
RememberMe	body	bool?	No
ErrorView	body	string	No
nonce	body	string	No
uri	body	string	No
response	body	string	No
qop	body	string	No
nc	body	string	No
cnonce	body	string	No
AccessToken	body	string	No
AccessTokenSecret	body	string	No
scope	body	string	No
Meta	body	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 .csv suffix or ?format=csv

HTTP + CSV

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

POST /api/auth HTTP/1.1 
Host: digiofficeapigateway.deltares.nl 
Accept: text/csv
Content-Type: text/csv
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","AccessToken":"String","AccessTokenSecret":"String","scope":"String","Meta":{"String":"String"}}

HTTP/1.1 200 OK
Content-Type: text/csv
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"}}