SalesForce Services

<back to all web services

Authenticate

The following routes are available for this service:
All Verbs/auth
All Verbs/auth/{provider}
All Verbs/authenticate
All Verbs/authenticate/{provider}
Authenticate Parameters:
NameParameterData TypeRequiredDescription
providerpathstringNo
StatequerystringNo
oauth_tokenquerystringNo
oauth_verifierquerystringNo
UserNamequerystringNo
PasswordquerystringNo
RememberMequerybool?No
ContinuequerystringNo
ErrorViewquerystringNo
noncequerystringNo
uriquerystringNo
responsequerystringNo
qopquerystringNo
ncquerystringNo
cnoncequerystringNo
UseTokenCookiequerybool?No
AccessTokenquerystringNo
AccessTokenSecretquerystringNo
scopequerystringNo
MetaqueryDictionary<string, string>No
AuthenticateResponse Parameters:
NameParameterData TypeRequiredDescription
ResponseStatusformResponseStatusNo
UserIdformstringNo
SessionIdformstringNo
UserNameformstringNo
DisplayNameformstringNo
ReferrerUrlformstringNo
BearerTokenformstringNo
RefreshTokenformstringNo
ProfileUrlformstringNo
RolesformList<string>No
PermissionsformList<string>No
MetaformDictionary<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 /auth HTTP/1.1 
Host: salesforceapi.avalonbay.com 
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,"continue":"String","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: 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"}}