Read User Permissions

Warning: OAuth 1.0 has been deprecated in favor of OAuth 2.0.

After obtaining an access token, a consumer can retrieve the user permissions of the currently authenticated user for a specific module or product.

URI

https://api.familysearch.org/identity/v2/permission

HTTP Method

GET

Parameters

&product=?

Request which product permissions are to be returned. (required)

FamilyTree: Return Family Tree permissions.

Permissions

Product	Permission	Description
FamilyTree	Access	Permission for general access.
	View	Permission to view general information.
	Modify	Permission to modify general information.
	View LDS Information	Permission to view LDS information.
	Modify LDS Information	Permission to modify LDS information.
	Access LDS Interface	Permission (or suggestion) to show an LDS user interface.
	Access Discussion Forums	Permission to access discussion forums.

Errors

Error	Possible Causes	Implemented
400	Bad Request. Generic client error.	Yes
401	Unauthorized. The user has invalid credentials or the session ID is missing, invalid, or has expired. This error also appears if the query string contains multiple question marks or the session parameter contains letters in an incorrect case.	Yes
403	Forbidden. The user does not have sufficient rights to perform the operation.	No
404	Not Found. This request contained an invalid ID or a bad URI.	Yes
415	Unsupported data format, unsupported media type, invalid content-type in header, or invalid character encoding.	No
430	Bad version. Incorrect version of the object.	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
503	Service Unavailable. FamilySearch or the service that you are using is not currently available. Or you are being throttled.	Yes

Examples

Request

GET https://api.familysearch.org/identity/v2/permission?product=FamilyTree&sessionId={sessionId}

Response

<?xml version='1.0' encoding='utf-8'?>
<identity xmlns="http://api.familysearch.org/identity/v2" statusCode="200" statusMessage="OK" version="2.7.20100901.6206">
  <permissions>
    <permission>Access</permission>
    <permission>View</permission>
    <permission>Modify</permission>
    <permission>View LDS Information</permission>
    <permission>Modify LDS Information</permission>
    <permission>Access LDS Interface</permission>
    <permission>Access Discussion Forums</permission>
  </permissions>
</identity>