Properties
Warning: OAuth 1.0 has been deprecated in favor of OAuth 2.0.
The properties endpoint of the Identity V2 module is especially important as it is the source for obtaining the URLs at which the OAuth endpoints are located.
In order to obtain an authenticated FamilySearch access token (used to identify the user session), the OAuth consumer must know three URLs that are used to implement the OAuth protocol:
- Request Token URL
- User Authorization URL
- Access Token URL
For details, refer to the OAuth specification.
The properties endpoint will supply these URLs with the following properties:
| URL |
Property Name |
|---|---|
| Request Token URL |
request.token.url |
| Authorization Token URL |
authorize.url |
| Access Token URL |
access.token.url |
Example
Request
https://api.familysearch.org/identity/v2/properties
Response
<?xml version="1.0" encoding="UTF-8"?>
<identity xmlns="http://api.familysearch.org/identity/v2" statusMessage="OK" statusCode="200">
<properties>
<property name="user.max.ids">0</property>
<property name="request.token.url">https://api.familysearch.org/identity/v2/request_token</property>
<property name="authorize.url">https://api.familysearch.org/identity/v2/authorize</property>
<property name="access.token.url">https://api.familysearch.org/identity/v2/access_token</property>
</properties>
</identity>