AuthProvider สำหรับ SAML
ลายเซ็น:
export declare class SAMLAuthProvider extends FederatedAuthProvider
ขยาย: FederatedAuthProvider
ผู้ผลิต
ผู้ผลิต | คีย์ตัวปรับแต่ง | คำอธิบาย |
---|---|---|
(เครื่องมือสร้าง)(รหัสผู้ให้บริการ) | เครื่องมือสร้าง providerId ต้องขึ้นต้นด้วย "saml" |
เมธอด
วิธีการ | คีย์ตัวปรับแต่ง | คำอธิบาย |
---|---|---|
credentialFromError(ข้อผิดพลาด) | static |
ใช้เพื่อดึงข้อมูล OAuthCredential ที่สำคัญจาก AuthError ที่ส่งระหว่างการลงชื่อเข้าใช้ ลิงก์ หรือตรวจสอบสิทธิ์อีกครั้ง |
credentialFromJSON(json) | static |
สร้าง AuthCredential จากสตริง JSON หรือออบเจ็กต์ทั่วไป |
credentialFromผลลัพธ์(userCredential) | static |
สร้าง AuthCredential จาก UserCredential หลังจากดำเนินการตามขั้นตอน SAML เรียบร้อยแล้ว |
SAMLAuthProvider.(เครื่องมือสร้าง)
เครื่องมือสร้าง providerId ต้องขึ้นต้นด้วย "saml"
ลายเซ็น:
constructor(providerId: string);
พารามิเตอร์
พารามิเตอร์ | ประเภท | คำอธิบาย |
---|---|---|
รหัสผู้ให้บริการ | สตริง | รหัสผู้ให้บริการ SAML |
SAMLAuthProvider.credentialFromError()
ใช้เพื่อดึงข้อมูล OAuthCredential ที่สำคัญจาก AuthError ที่ส่งระหว่างการลงชื่อเข้าใช้ ลิงก์ หรือตรวจสอบสิทธิ์อีกครั้ง
ลายเซ็น:
static credentialFromError(error: FirebaseError): AuthCredential | null;
พารามิเตอร์
พารามิเตอร์ | ประเภท | คำอธิบาย |
---|---|---|
ข้อผิดพลาด | ข้อผิดพลาด Firebase |
การคืนสินค้า:
AuthCredential | ค่าว่าง
SAMLAuthProvider.credentialFromJSON()
สร้าง AuthCredential จากสตริง JSON หรือออบเจ็กต์ทั่วไป
ลายเซ็น:
static credentialFromJSON(json: string | object): AuthCredential;
พารามิเตอร์
พารามิเตอร์ | ประเภท | คำอธิบาย |
---|---|---|
JSON | สตริง | ออบเจ็กต์ | ออบเจ็กต์ธรรมดาหรือสตริง JSON |
การคืนสินค้า:
SAMLAuthProvider.credentialFromResult()
สร้าง AuthCredential จาก UserCredential หลังจากดำเนินการตามขั้นตอน SAML เรียบร้อยแล้ว
ตัวอย่างเช่น หากต้องการรับ AuthCredential คุณสามารถเขียนโค้ดต่อไปนี้ได้
const userCredential = await signInWithPopup(auth, samlProvider);
const credential = SAMLAuthProvider.credentialFromResult(userCredential);
ลายเซ็น:
static credentialFromResult(userCredential: UserCredential): AuthCredential | null;
พารามิเตอร์
พารามิเตอร์ | ประเภท | คำอธิบาย |
---|---|---|
ข้อมูลเข้าสู่ระบบของผู้ใช้ | รหัสผู้ใช้ | ข้อมูลเข้าสู่ระบบของผู้ใช้ |
การคืนสินค้า:
AuthCredential | ค่าว่าง