"description":"Selector specifying which fields to include in a partial response.",
"location":"query"
},
"key":{
"type":"string",
"description":"API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.",
"location":"query"
},
"oauth_token":{
"type":"string",
"description":"OAuth 2.0 token for the current user.",
"location":"query"
},
"prettyPrint":{
"type":"boolean",
"description":"Returns response with indentations and line breaks.",
"default":"true",
"location":"query"
},
"quotaUser":{
"type":"string",
"description":"Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. Overrides userIp if both are provided.",
"location":"query"
},
"userIp":{
"type":"string",
"description":"IP address of the site where the request originates. Use this if you want to enforce per-user limits.",
"description":"Request to get the IDP authentication URL.",
"properties":{
"appId":{
"type":"string",
"description":"The app ID of the mobile app, base64(CERT_SHA1):PACKAGE_NAME for Android, BUNDLE_ID for iOS."
},
"authFlowType":{
"type":"string",
"description":"Explicitly specify the auth flow type. Currently only support \"CODE_FLOW\" type. The field is only used for Google provider."
},
"clientId":{
"type":"string",
"description":"The relying party OAuth client ID."
},
"context":{
"type":"string",
"description":"The opaque value used by the client to maintain context info between the authentication request and the IDP callback."
},
"continueUri":{
"type":"string",
"description":"The URI to which the IDP redirects the user after the federated login flow."
},
"customParameter":{
"type":"object",
"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.",
"additionalProperties":{
"type":"string",
"description":"The customized query parameter."
}
},
"hostedDomain":{
"type":"string",
"description":"The hosted domain to restrict sign-in to accounts at that domain for Google Apps hosted accounts."
},
"identifier":{
"type":"string",
"description":"The email or federated ID of the user."
},
"oauthConsumerKey":{
"type":"string",
"description":"The developer's consumer key for OpenId OAuth Extension"
},
"oauthScope":{
"type":"string",
"description":"Additional oauth scopes, beyond the basid user profile, that the user would be prompted to grant"
},
"openidRealm":{
"type":"string",
"description":"Optional realm for OpenID protocol. The sub string \"scheme://domain:port\" of the param \"continueUri\" is used if this is not set."
},
"otaApp":{
"type":"string",
"description":"The native app package for OTA installation."
},
"providerId":{
"type":"string",
"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."
"description":"Request to verify the IDP assertion.",
"properties":{
"autoCreate":{
"type":"boolean",
"description":"When it's true, automatically creates a new account if the user doesn't exist. When it's false, allows existing user to sign in normally and throws exception if the user doesn't exist."
},
"delegatedProjectNumber":{
"type":"string",
"description":"GCP project number of the requesting delegated app. Currently only intended for Firebase V1 migration.",
"format":"int64"
},
"idToken":{
"type":"string",
"description":"The GITKit token of the authenticated user."
},
"instanceId":{
"type":"string",
"description":"Instance id token of the app."
},
"pendingIdToken":{
"type":"string",
"description":"The GITKit token for the non-trusted IDP pending to be confirmed by the user."
},
"postBody":{
"type":"string",
"description":"The post body if the request is a HTTP POST."
},
"requestUri":{
"type":"string",
"description":"The URI to which the IDP redirects the user back. It may contain federated login result params added by the IDP."
},
"returnIdpCredential":{
"type":"boolean",
"description":"Whether return 200 and IDP credential rather than throw exception when federated id is already linked."
},
"returnRefreshToken":{
"type":"boolean",
"description":"Whether to return refresh tokens."
},
"returnSecureToken":{
"type":"boolean",
"description":"Whether return sts id token and refresh token instead of gitkit token."
},
"sessionId":{
"type":"string",
"description":"Session ID, which should match the one in previous createAuthUri request."
"description":"Template for a single idp configuration.",
"properties":{
"clientId":{
"type":"string",
"description":"OAuth2 client ID."
},
"enabled":{
"type":"boolean",
"description":"Whether this IDP is enabled."
},
"experimentPercent":{
"type":"integer",
"description":"Percent of users who will be prompted/redirected federated login for this IDP.",
"format":"int32"
},
"provider":{
"type":"string",
"description":"OAuth2 provider."
},
"secret":{
"type":"string",
"description":"OAuth2 client secret."
},
"whitelistedAudiences":{
"type":"array",
"description":"Whitelisted client IDs for audience check.",
"items":{
"type":"string"
}
}
}
},
"Relyingparty":{
"id":"Relyingparty",
"type":"object",
"description":"Request of getting a code for user confirmation (reset password, change email etc.)",
"properties":{
"androidInstallApp":{
"type":"boolean",
"description":"whether or not to install the android app on the device where the link is opened"
},
"androidMinimumVersion":{
"type":"string",
"description":"minimum version of the app. if the version on the device is lower than this version then the user is taken to the play store to upgrade the app"
},
"androidPackageName":{
"type":"string",
"description":"android package name of the android app to handle the action code"
},
"canHandleCodeInApp":{
"type":"boolean",
"description":"whether or not the app can handle the oob code without first going to web"
},
"captchaResp":{
"type":"string",
"description":"The recaptcha response from the user."
},
"challenge":{
"type":"string",
"description":"The recaptcha challenge presented to the user."
},
"continueUrl":{
"type":"string",
"description":"The url to continue to the Gitkit app"
},
"email":{
"type":"string",
"description":"The email of the user."
},
"iOSAppStoreId":{
"type":"string",
"description":"iOS app store id to download the app if it's not already installed"
},
"iOSBundleId":{
"type":"string",
"description":"the iOS bundle id of iOS app to handle the action code"
},
"idToken":{
"type":"string",
"description":"The user's Gitkit login token for email change."
"description":"The new email the user attempts to change to."
},
"passwordHash":{
"type":"string",
"description":"The user's hashed password.",
"format":"byte"
},
"photoUrl":{
"type":"string",
"description":"The photo url of the user."
},
"providerUserInfo":{
"type":"array",
"description":"The user's profiles at the associated IdPs.",
"items":{
"type":"object",
"properties":{
"displayName":{
"type":"string",
"description":"The user's display name at the IDP."
},
"federatedId":{
"type":"string",
"description":"User's identifier at IDP."
},
"photoUrl":{
"type":"string",
"description":"The user's photo url at the IDP."
},
"providerId":{
"type":"string",
"description":"The IdP ID. For whitelisted 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."
}
}
}
},
"refreshToken":{
"type":"string",
"description":"If idToken is STS id token, then this field will be refresh token."
}
}
},
"SignupNewUserResponse":{
"id":"SignupNewUserResponse",
"type":"object",
"description":"Response of signing up new user, creating anonymous user or anonymous user reauth.",
"properties":{
"displayName":{
"type":"string",
"description":"The name of the user."
},
"email":{
"type":"string",
"description":"The email of the user."
},
"expiresIn":{
"type":"string",
"description":"If idToken is STS id token, then this field will be expiration time of STS id token in seconds.",
"format":"int64"
},
"idToken":{
"type":"string",
"description":"The Gitkit id token to login the newly sign up user."
"description":"Whether the user is authenticated by the developer."
},
"disabled":{
"type":"boolean",
"description":"Whether the user is disabled."
},
"displayName":{
"type":"string",
"description":"The name of the user."
},
"email":{
"type":"string",
"description":"The email of the user."
},
"emailVerified":{
"type":"boolean",
"description":"Whether the email has been verified."
},
"lastLoginAt":{
"type":"string",
"description":"last login timestamp.",
"format":"int64"
},
"localId":{
"type":"string",
"description":"The local ID of the user."
},
"passwordHash":{
"type":"string",
"description":"The user's hashed password.",
"format":"byte"
},
"passwordUpdatedAt":{
"type":"number",
"description":"The timestamp when the password was last updated.",
"format":"double"
},
"phoneNumber":{
"type":"string",
"description":"User's phone number."
},
"photoUrl":{
"type":"string",
"description":"The URL of the user profile photo."
},
"providerUserInfo":{
"type":"array",
"description":"The IDP of the user.",
"items":{
"type":"object",
"properties":{
"displayName":{
"type":"string",
"description":"The user's display name at the IDP."
},
"email":{
"type":"string",
"description":"User's email at IDP."
},
"federatedId":{
"type":"string",
"description":"User's identifier at IDP."
},
"phoneNumber":{
"type":"string",
"description":"User's phone number."
},
"photoUrl":{
"type":"string",
"description":"The user's photo url at the IDP."
},
"providerId":{
"type":"string",
"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."
},
"rawId":{
"type":"string",
"description":"User's raw identifier directly returned from IDP."
},
"screenName":{
"type":"string",
"description":"User's screen name at Twitter or login name at Github."
}
}
}
},
"rawPassword":{
"type":"string",
"description":"The user's plain text password."
},
"salt":{
"type":"string",
"description":"The user's password salt.",
"format":"byte"
},
"screenName":{
"type":"string",
"description":"User's screen name at Twitter or login name at Github."
},
"validSince":{
"type":"string",
"description":"Timestamp in seconds for valid login token.",
"format":"int64"
},
"version":{
"type":"integer",
"description":"Version of the user's password.",
"format":"int32"
}
}
},
"VerifyAssertionResponse":{
"id":"VerifyAssertionResponse",
"type":"object",
"description":"Response of verifying the IDP assertion.",
"properties":{
"action":{
"type":"string",
"description":"The action code."
},
"appInstallationUrl":{
"type":"string",
"description":"URL for OTA app installation."
},
"appScheme":{
"type":"string",
"description":"The custom scheme used by mobile app."
},
"context":{
"type":"string",
"description":"The opaque value used by the client to maintain context info between the authentication request and the IDP callback."
},
"dateOfBirth":{
"type":"string",
"description":"The birth date of the IdP account."
},
"displayName":{
"type":"string",
"description":"The display name of the user."
},
"email":{
"type":"string",
"description":"The email returned by the IdP. NOTE: The federated login user may not own the email."
},
"emailRecycled":{
"type":"boolean",
"description":"It's true if the email is recycled."
},
"emailVerified":{
"type":"boolean",
"description":"The value is true if the IDP is also the email provider. It means the user owns the email."
},
"errorMessage":{
"type":"string",
"description":"Client error code."
},
"expiresIn":{
"type":"string",
"description":"If idToken is STS id token, then this field will be expiration time of STS id token in seconds.",
"format":"int64"
},
"federatedId":{
"type":"string",
"description":"The unique ID identifies the IdP account."
},
"firstName":{
"type":"string",
"description":"The first name of the user."
},
"fullName":{
"type":"string",
"description":"The full name of the user."
},
"idToken":{
"type":"string",
"description":"The ID token."
},
"inputEmail":{
"type":"string",
"description":"It's the identifier param in the createAuthUri request if the identifier is an email. It can be used to check whether the user input email is different from the asserted email."
},
"isNewUser":{
"type":"boolean",
"description":"True if it's a new user sign-in, false if it's a returning user."
"description":"The language preference of the user."
},
"lastName":{
"type":"string",
"description":"The last name of the user."
},
"localId":{
"type":"string",
"description":"The RP local ID if it's already been mapped to the IdP account identified by the federated ID."
},
"needConfirmation":{
"type":"boolean",
"description":"Whether the assertion is from a non-trusted IDP and need account linking confirmation."
},
"needEmail":{
"type":"boolean",
"description":"Whether need client to supply email to complete the federated login flow."
},
"nickName":{
"type":"string",
"description":"The nick name of the user."
},
"oauthAccessToken":{
"type":"string",
"description":"The OAuth2 access token."
},
"oauthAuthorizationCode":{
"type":"string",
"description":"The OAuth2 authorization code."
},
"oauthExpireIn":{
"type":"integer",
"description":"The lifetime in seconds of the OAuth2 access token.",
"format":"int32"
},
"oauthIdToken":{
"type":"string",
"description":"The OIDC id token."
},
"oauthRequestToken":{
"type":"string",
"description":"The user approved request token for the OpenID OAuth extension."
},
"oauthScope":{
"type":"string",
"description":"The scope for the OpenID OAuth extension."
},
"oauthTokenSecret":{
"type":"string",
"description":"The OAuth1 access token secret."
},
"originalEmail":{
"type":"string",
"description":"The original email stored in the mapping storage. It's returned when the federated ID is associated to a different email."
},
"photoUrl":{
"type":"string",
"description":"The URI of the public accessible profiel picture."
},
"providerId":{
"type":"string",
"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. If the \"providerId\" param is set to OpenID OP identifer other than the whilte listed IdPs the OP identifier is returned. If the \"identifier\" param is federated ID in the createAuthUri request. The domain part of the federated ID is returned."
},
"rawUserInfo":{
"type":"string",
"description":"Raw IDP-returned user info."
},
"refreshToken":{
"type":"string",
"description":"If idToken is STS id token, then this field will be refresh token."
},
"screenName":{
"type":"string",
"description":"The screen_name of a Twitter user or the login name at Github."
},
"timeZone":{
"type":"string",
"description":"The timezone of the user."
},
"verifiedProvider":{
"type":"array",
"description":"When action is 'map', contains the idps which can be used for confirmation.",
"items":{
"type":"string"
}
}
}
},
"VerifyCustomTokenResponse":{
"id":"VerifyCustomTokenResponse",
"type":"object",
"description":"Response from verifying a custom token",
"properties":{
"expiresIn":{
"type":"string",
"description":"If idToken is STS id token, then this field will be expiration time of STS id token in seconds.",
"format":"int64"
},
"idToken":{
"type":"string",
"description":"The GITKit token for authenticated user."
