Get Access Token
Warning: OAuth 1.0 has been deprecated in favor of OAuth 2.0.
With a request token and verifier, your application can request an access token, which is used to identify the user session and access the FamilySearch APIs.
Parameters
- oauth_consumer_key
- Your developer key.
- oauth_verifier
- A verification code tied to the request token.
- oauth_nonce
- A random string (see OAuth Core 1.0a Spec, Section 8).
- oauth_signature_method
- The
OAuth signature method. The value of this parameter will always be
"PLAINTEXT". For more information on the plain text signature method,
see OAuth Core 1.0a Spec, Section 9.4.
Note: Plain text can be used because the FamilySearch identity system also requires that all communication occur over SSL/TLS.
- oauth_signature
- Because PLAINTEXT is the signature method and because the "consumer secret" is the empty string, the value of the signature will always be "%26TOKEN_SECRET" where TOKEN_SECRET is the request token secret supplied when obtaining a request token. For details, refer to the OAuth Core 1.0a Spec, Section 9.4.
- oauth_timestamp
- Current timestamp of the request (number of seconds since January 1, 1970 00:00:00 GMT). This value must be +-5 minutes of the current time. (see OAuth Core 1.0a Spec, Section 8).
- oauth_token
- The request token.
Response
The request token endpoint responds with the following information, in the format defined by the OAuth specification:
- oauth_token
- The access token.
- oauth_token_secret
- This secret associated with the access token.
Errors
| Error | Possible Causes | API-Specific Examples | Implemented |
|---|---|---|---|
| 400 | Bad Request. |
Invalid parameter values. | Yes |
| 401 | Unauthorized. Invalid developer key or no user agent supplied. |
|
Yes |
| 500 | Server Error. A generic server error or multiple server errors occurred. If you get this error, please report it through devsupport@familysearch.org. You can also post it to the FamilySearch Developer Network (FSDN). |
|
Yes |
Example 1: Using GET Method
Request (GET)
Response
https://api.familysearch.org/identity/v2/access_token?oauth_consumer_key=DEVKEY&oauth_nonce=123456789&oauth_signature_method=PLAINTEXT&oauth_signature=%2617063cb9f3179fc0d8ef8768127b0428&oauth_timestamp=1252618480&oauth_verifier=dae616
oauth_token=A364751F9E72B5BC23235707071D942C&oauth_token_secret=17063cb9f3179fc0d8ef8768127b0428
Example 2: Using the POST Method
Request (POST)
https://api.familysearch.org/identity/v2/access_token
Request Payload
oauth_consumer_key=DEVKEY&oauth_nonce=123456789&oauth_signature_method=PLAINTEXT&oauth_signature=%2617063cb9f3179fc0d8ef8768127b0428&oauth_timestamp=1252618480&oauth_verifier=dae616Response
oauth_token=A364751F9E72B5BC23235707071D942C&oauth_token_secret=17063cb9f3179fc0d8ef8768127b0428