---
title: "POST /createAuthUri"
method: POST
path: "/createAuthUri"
tags: ["relyingparty"]
---

# POST /createAuthUri

`POST /createAuthUri`

Creates the URI used by the IdP to authenticate the user.

## Request body

- IdentitytoolkitRelyingpartyCreateAuthUriRequest — Request to get the IDP authentication URL.
  - `oauthScope` string — Additional oauth scopes, beyond the basid user profile, that the user would be prompted to grant
  - `identifier` string — The email or federated ID of the user.
  - `sessionId` string — The session_id passed by client.
  - `openidRealm` string — Optional realm for OpenID protocol. The sub string "scheme://domain:port" of the param "continueUri" is used if this is not set.
  - `oauthConsumerKey` string — The developer's consumer key for OpenId OAuth Extension
  - `clientId` string — The relying party OAuth client ID.
  - `tenantId` string — For multi-tenant use cases, in order to construct sign-in URL with the correct IDP parameters, Firebear needs to know which Tenant to retrieve IDP configs from.
  - `hostedDomain` string — The hosted domain to restrict sign-in to accounts at that domain for Google Apps hosted accounts.
  - `tenantProjectNumber` string, uint64 — Tenant project number to be used for idp discovery.
  - `customParameter` object — The query parameter that client can customize by themselves in auth url. The following parameters are reserved for server so that they cannot be customized by clients: client_id, response_type, scope, redirect_uri, state, oauth_token.
  - `providerId` string — The IdP ID. For white listed IdPs it's a short domain name e.g. google.com, aol.com, live.net and yahoo.com. For other OpenID IdPs it's the OP identifier.
  - `continueUri` string — The URI to which the IDP redirects the user after the federated login flow.
  - `otaApp` string — The native app package for OTA installation.
  - `appId` string — The app ID of the mobile app, base64(CERT_SHA1):PACKAGE_NAME for Android, BUNDLE_ID for iOS.
  - `context` string — The opaque value used by the client to maintain context info between the authentication request and the IDP callback.
  - `authFlowType` string — Explicitly specify the auth flow type. Currently only support "CODE_FLOW" type. The field is only used for Google provider.

## Response `200`

Successful response

---

[API](https://skmtc.net/google/apis/identitytoolkit.md) · [All operations](https://skmtc.net/google/apis/identitytoolkit/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/google/identitytoolkit/versions/9ea63f196a10/schema)