Authorization

Description

The Authorization resource is used to initiate the process for obtaining an authorization code that can be used to obtain an access token.

The Authorization resource is the Web page where a user is to be directed to authenticate. Upon successful authentication, the user will be redirected to the specified redirect URI with the authorization "code" and "state" query parameters as defined by RFC 6749, Section 4.1.2. If authorization is unsuccessful, the user will be redirected to the specified redirect URI with the "error" query parameter as defined by RFC 6749, Section 4.1.2.1.

Data Formats

If you make a GET request, specify the data format using the Accept header.

If you POST something, specify the media type using the Content-Type header.

  • application/x-www-form-urlencoded
  • text/html

Parameters

Name Type Description
response_type query The response type, which must have the value "code".
state query Client state (optional).
redirect_uri query The URI to which the user will be directed with the result of the authentication. This parameter is optional. If provided, the URI must be pre-registered with the developer key. To register a URI, contact developer support.
client_id query The FamilySearch application key.

Operations

GET - Get the authorization page.

Status Codes

POST - Get the authorization page.

Status Codes

Example Requests

Initiate Authorization (GET) How to initiate the process for obtaining an OAuth 2 authorization code with HTTP GET.
Initiate Authorization (Invalid Parameter) Example illustrating the result of invalid parameters when initiating the process for obtaining an OAuth 2 authorization code.
Initiate Authorization (POST) How to initiate the process for obtaining an OAuth 2 authorization code with HTTP POST.