relyingparty_auth_uri

Creates, updates, deletes, gets or lists a relyingparty_auth_uri resource.

Overview

Name	relyingparty_auth_uri
Type	Resource
Id	google.identitytoolkit.relyingparty_auth_uri

Fields

The following fields are returned by SELECT queries:

SELECT not supported for this resource, use SHOW METHODS to view available operations for the resource.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
create_auth_uri	insert			Creates the URI used by the IdP to authenticate the user.

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description

INSERT examples

create_auth_uri

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

INSERT INTO google.identitytoolkit.relyingparty_auth_uri (
data__appId,
data__authFlowType,
data__clientId,
data__context,
data__continueUri,
data__customParameter,
data__hostedDomain,
data__identifier,
data__oauthConsumerKey,
data__oauthScope,
data__openidRealm,
data__otaApp,
data__providerId,
data__sessionId,
data__tenantId,
data__tenantProjectNumber
)
SELECT 
'{{ appId }}',
'{{ authFlowType }}',
'{{ clientId }}',
'{{ context }}',
'{{ continueUri }}',
'{{ customParameter }}',
'{{ hostedDomain }}',
'{{ identifier }}',
'{{ oauthConsumerKey }}',
'{{ oauthScope }}',
'{{ openidRealm }}',
'{{ otaApp }}',
'{{ providerId }}',
'{{ sessionId }}',
'{{ tenantId }}',
'{{ tenantProjectNumber }}'
RETURNING
allProviders,
authUri,
captchaRequired,
forExistingProvider,
kind,
providerId,
registered,
sessionId,
signinMethods
;

Manifest

# Description fields are for documentation purposes
- name: relyingparty_auth_uri
props:
  - name: appId
    value: "{{ appId }}"
    description: |
      The app ID of the mobile app, base64(CERT_SHA1):PACKAGE_NAME for Android, BUNDLE_ID for iOS.
  - name: authFlowType
    value: "{{ authFlowType }}"
    description: |
      Explicitly specify the auth flow type. Currently only support "CODE_FLOW" type. The field is only used for Google provider.
  - name: clientId
    value: "{{ clientId }}"
    description: |
      The relying party OAuth client ID.
  - name: context
    value: "{{ context }}"
    description: |
      The opaque value used by the client to maintain context info between the authentication request and the IDP callback.
  - name: continueUri
    value: "{{ continueUri }}"
    description: |
      The URI to which the IDP redirects the user after the federated login flow.
  - name: customParameter
    value: "{{ customParameter }}"
    description: |
      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.
  - name: hostedDomain
    value: "{{ hostedDomain }}"
    description: |
      The hosted domain to restrict sign-in to accounts at that domain for Google Apps hosted accounts.
  - name: identifier
    value: "{{ identifier }}"
    description: |
      The email or federated ID of the user.
  - name: oauthConsumerKey
    value: "{{ oauthConsumerKey }}"
    description: |
      The developer's consumer key for OpenId OAuth Extension
  - name: oauthScope
    value: "{{ oauthScope }}"
    description: |
      Additional oauth scopes, beyond the basid user profile, that the user would be prompted to grant
  - name: openidRealm
    value: "{{ openidRealm }}"
    description: |
      Optional realm for OpenID protocol. The sub string "scheme://domain:port" of the param "continueUri" is used if this is not set.
  - name: otaApp
    value: "{{ otaApp }}"
    description: |
      The native app package for OTA installation.
  - name: providerId
    value: "{{ providerId }}"
    description: |
      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.
  - name: sessionId
    value: "{{ sessionId }}"
    description: |
      The session_id passed by client.
  - name: tenantId
    value: "{{ tenantId }}"
    description: |
      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.
  - name: tenantProjectNumber
    value: "{{ tenantProjectNumber }}"
    description: |
      Tenant project number to be used for idp discovery.