PPulse Chat / API docs

OAuth Providers

Query · oauthProviders

oauthProviders: [OAuthProviderName!]!

Dùng query này để quyết định nút đăng nhập OAuth nào có thể hiển thị. API chỉ liệt kê nhà cung cấp có cả client ID và client secret trong cấu hình. Kết quả có thể thay đổi khi cấu hình máy chủ thay đổi.

Gửi qua HTTP POST /graphql. Không cần access token hoặc quyền thành viên workspace/conversation. Query này không có guard giới hạn số lần gọi của các mutation xác thực.

Input

Query không có đối số, input object hoặc giá trị mặc định.

Output

Trả về [OAuthProviderName!]!: danh sách không null, mỗi phần tử không null. Danh sách rỗng [] nghĩa là không có nhà cung cấp nào đang được cấu hình. Các giá trị enum:

Giá trịÝ nghĩa
GOOGLEĐăng nhập qua Google khi máy chủ có cấu hình Google.

Việc một provider có mặt trong danh sách cho biết cấu hình credential tồn tại; nó không bảo đảm dịch vụ bên ngoài đang hoạt động.

Ví dụ

query OAuthProviders {
  oauthProviders
}

Phản hồi minh họa khi chỉ Google được cấu hình:

{
  "data": {
    "oauthProviders": ["GOOGLE"]
  }
}

Nếu chưa cấu hình provider nào, oauthProviders trả []. Sau khi chọn một giá trị, gọi oauthAuthorizationUrl để bắt đầu luồng đăng nhập.

Chữ ký operation được tạo từ GraphQL schema.