v1

latestOpenAPI 3.0.0Creative Commons Attribution 3.02026-07-13204059.1 KB
relyingparty

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

post/createAuthUri

Request body

oauthScopestring

Additional oauth scopes, beyond the basid user profile, that the user would be prompted to grant

identifierstring

The email or federated ID of the user.

sessionIdstring

The session_id passed by client.

openidRealmstring

Optional realm for OpenID protocol. The sub string "scheme://domain:port" of the param "continueUri" is used if this is not set.

oauthConsumerKeystring

The developer's consumer key for OpenId OAuth Extension

clientIdstring

The relying party OAuth client ID.

tenantIdstring

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.

hostedDomainstring

The hosted domain to restrict sign-in to accounts at that domain for Google Apps hosted accounts.

tenantProjectNumberstring uint64

Tenant project number to be used for idp discovery.

customParameterobject

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.

providerIdstring

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.

continueUristring

The URI to which the IDP redirects the user after the federated login flow.

otaAppstring

The native app package for OTA installation.

appIdstring

The app ID of the mobile app, base64(CERT_SHA1):PACKAGE_NAME for Android, BUNDLE_ID for iOS.

contextstring

The opaque value used by the client to maintain context info between the authentication request and the IDP callback.

authFlowTypestring

Explicitly specify the auth flow type. Currently only support "CODE_FLOW" type. The field is only used for Google provider.

Response

Successful response