Skip to content

Commit 2b37527

Browse files
committed
Update README and manifest for OpenID Connect API Proxy: add description, features, and update icon
1 parent f099ab6 commit 2b37527

File tree

3 files changed

+28
-4
lines changed

3 files changed

+28
-4
lines changed

README.md

Lines changed: 26 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,5 @@
1+
![Icon](./_assets/icon-oidc-api-proxy.jpg)
2+
13
# OpenID Connect API Proxy
24

35
[![GitHub Repo](https://img.shields.io/badge/GitHub_Repo-fujita--h/dify--plugin--oidc--api--proxy-blue?logo=github)](https://github.com/fujita-h/dify-plugin-oidc-api-proxy)
@@ -6,6 +8,28 @@
68

79
This plugin relays the API provided by Dify chat/workflow with OpenID Connect authentication enabled.
810

11+
## Description
12+
13+
This plugin provides the same API endpoints as the Dify Chat/Workflow API, but uses OpenID Connect authentication instead of Dify's API key authentication.
14+
15+
You can use the endpoints created by this plugin to provide per-user authentication to the API.
16+
17+
## Features
18+
19+
### OpenID Connect authentication
20+
21+
This plugin uses OpenID Connect authentication to authenticate users. You can access the API with the access token obtained by authenticating with OpenID Connect.
22+
23+
### User parameter replacement
24+
25+
You can also replace the `user` parameter specified in the original API with OpenID Connect authenticated claim data. For example, if you replace it with an email address, the user's email address will be displayed on the Dify app log screen.
26+
27+
### Input claim data to the Chat/Workflow App
28+
29+
Plugin automatically inputs the claim data obtained by OpenID Connect authentication into the Chat/Workflow App. You can use the claim data in the Chat/Workflow App.
30+
31+
To use the claim data in the Chat/Workflow App, you need to specify the claim data name to the Start node's `input` parameter. For example, if you specify `__oidc_email` to the `input` parameter, you can use the email address in the Chat/Workflow App.
32+
33+
## Contributing
934

10-
> [!IMPORTANT]
11-
> This plugin is still under development and not yet released. Please wait for the release.
35+
This plugin is open-source and contributions are welcome. Please visit the GitHub repository to contribute.

_assets/icon-oidc-api-proxy.jpg

7.18 KB
Loading

manifest.yaml

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -3,10 +3,10 @@ type: plugin
33
author: fujita-h
44
name: oidc_api_proxy
55
label:
6-
en_US: oidc_api_proxy
6+
en_US: OpenID Connect API Proxy
77
description:
88
en_US: This plugin relays the API provided by Dify chat/workflow with OpenID Connect authentication enabled.
9-
icon: icon.svg
9+
icon: icon-oidc-api-proxy.jpg
1010
resource:
1111
memory: 268435456
1212
permission:

0 commit comments

Comments
 (0)