| All Verbs | /auth | ||
|---|---|---|---|
| All Verbs | /auth/{provider} | ||
| All Verbs | /authenticate | ||
| All Verbs | /authenticate/{provider} |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| 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 | |
| Continue | query | string | 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 |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| ResponseStatus | form | ResponseStatus | No | |
| 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 | |
| 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
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: 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,"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: 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"}}