Get Authorization Page

get

https://identbeta.familysearch.org/cis-web/oauth2/v3/authorization

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.

Query Params

response_type

string

enum

required

The response type, must be 'code' for authorization code flow.

Allowed:

client_id

string

required

The FamilySearch application or developer key. Required.

redirect_uri

string

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.

scope

string

The scope of the request in the form of space-delimited case sensitive strings (optional). Specific scopes are defined with openidConnect.

code_challenge

string

This is the hashed and encoded random string described in the PKCE.

code_challenge_method

string

enum

This should be set to "S256" if using a SHA 256 hash method. Set to "plain" if your application is unable to hash the code verifier.

Allowed:

state

string

Client state.

prompt

string

enum

Forces user re-authentication even if they have an active session.

Allowed:

Responses

200

The read was successful.

400

Invalid request parameters

500

Internal server error

Language

Response

Click Try It! to start a request and see the response here!