Mit Sammlungen den Überblick behalten
Sie können Inhalte basierend auf Ihren Einstellungen speichern und kategorisieren.
Referenz zu Blockierfunktionen
Auf dieser Seite werden die AdditionalUserInfo- und AuthCredential-Schnittstellen beschrieben, die bei Verwendung der Blockierfunktionen von Identity Platform verfügbar sind.
AdditionalUserInfo
interfaceAdditionalUserInfo{// The provider ID, such as saml.provider, oidc.provider, google.com,// facebook.com, etc.providerId:string;// Raw user info. This is the raw user info also returned in client SDK.profile?:any;// This is the Twitter screen_name.username?:string;// Whether the user is new or existing.// This is true for beforeCreate, false for others.isNewUser:boolean;}
interfaceAuthCredential{// All user SAML or OIDC claims. These are in plain object format but should// be verified and parsed from SAML response, IdP ID token, etc.// This is empty for all other providers.claims?:{[key:string]:any};// Optional OAuth ID token if available and enabled in the project config.idToken?:string;// Optional OAuth access token if available and enabled in the project config.accessToken?:string;// Optional OAuth refresh token if available and enabled in the project config.refreshToken?:string;// Optional OAuth expiration if available and enabled in the project config.expirationTime?:string;// Optional OAuth token secret if available and enabled in the project config.secret?:string;// eg. saml.provider, oidc.provider, google.com, facebook.com, etc.providerId:string;}
[[["Leicht verständlich","easyToUnderstand","thumb-up"],["Mein Problem wurde gelöst","solvedMyProblem","thumb-up"],["Sonstiges","otherUp","thumb-up"]],[["Schwer verständlich","hardToUnderstand","thumb-down"],["Informationen oder Beispielcode falsch","incorrectInformationOrSampleCode","thumb-down"],["Benötigte Informationen/Beispiele nicht gefunden","missingTheInformationSamplesINeed","thumb-down"],["Problem mit der Übersetzung","translationIssue","thumb-down"],["Sonstiges","otherDown","thumb-down"]],["Zuletzt aktualisiert: 2025-05-14 (UTC)."],[[["\u003cp\u003eThis page provides information on the \u003ccode\u003eAdditionalUserInfo\u003c/code\u003e and \u003ccode\u003eAuthCredential\u003c/code\u003e interfaces used with Identity Platform blocking functions.\u003c/p\u003e\n"],["\u003cp\u003eThe \u003ccode\u003eAdditionalUserInfo\u003c/code\u003e interface includes details like the provider ID, raw user profile, username, and whether the user is new.\u003c/p\u003e\n"],["\u003cp\u003eThe \u003ccode\u003eAuthCredential\u003c/code\u003e interface contains user claims, optional OAuth tokens, and the provider ID.\u003c/p\u003e\n"],["\u003cp\u003eThe \u003ccode\u003eAuthCredential\u003c/code\u003e interface provides various credentials like OAuth ID, access, refresh tokens, and their expiration time if they are available.\u003c/p\u003e\n"],["\u003cp\u003eMore information on supported OAuth credentials and data is available via the provided link.\u003c/p\u003e\n"]]],[],null,["# Blocking functions reference\n============================\n\nThis page describes the `AdditionalUserInfo` and `AuthCredential` interfaces\nthat are available when using Identity Platform\n[blocking functions](/identity-platform/docs/blocking-functions).\n\nAdditionalUserInfo\n------------------\n\n interface AdditionalUserInfo {\n // The provider ID, such as saml.provider, oidc.provider, google.com,\n // facebook.com, etc.\n providerId: string;\n // Raw user info. This is the raw user info also returned in client SDK.\n profile?: any;\n // This is the Twitter screen_name.\n username?: string;\n // Whether the user is new or existing.\n // This is true for beforeCreate, false for others.\n isNewUser: boolean;\n }\n\nAuthCredential\n--------------\n\nSee [Supported OAuth credentials and data](/identity-platform/docs/blocking-functions#supported_credentials)\nfor more information. \n\n interface AuthCredential {\n // All user SAML or OIDC claims. These are in plain object format but should\n // be verified and parsed from SAML response, IdP ID token, etc.\n // This is empty for all other providers.\n claims?: {[key: string]: any};\n // Optional OAuth ID token if available and enabled in the project config.\n idToken?: string;\n // Optional OAuth access token if available and enabled in the project config.\n accessToken?: string;\n // Optional OAuth refresh token if available and enabled in the project config.\n refreshToken?: string;\n // Optional OAuth expiration if available and enabled in the project config.\n expirationTime?: string;\n // Optional OAuth token secret if available and enabled in the project config.\n secret?: string;\n // eg. saml.provider, oidc.provider, google.com, facebook.com, etc.\n providerId: string;\n }"]]