OIDC endpoints (Admin API)
4 FeatherPanel Admin API endpoints from admin/oidc.php: methods, paths, auth, permissions, rate limits, parameters and responses.
Last synced from FeatherPanel 15b94e9 on .
On this page
Defined in backend/app/routes/admin/oidc.php. Authentication used here: Admin. Read Authentication for how to send credentials and Rate limits and errors for the response envelope.
Paths, methods, permissions and rate limits come from the route file. Summaries, parameters and response codes come from the OpenAPI annotations on the controllers; endpoints without annotations show only what the route file declares.
Endpoints
GET/api/admin/oidc/providers
List OIDC providers
Response data field | Type | Description |
|---|---|---|
providers | OidcProvider[] |
curl -X GET "$PANEL_URL/api/admin/oidc/providers" \
-H "Authorization: Bearer $FEATHERPANEL_API_KEY" \
-H "Accept: application/json"Responses: 200 Providers retrieved successfully
PUT/api/admin/oidc/providers
Create OIDC provider
Request body: OidcProvider (application/json)
| Body field | Type | Required | Description |
|---|---|---|---|
uuid | string (uuid) | no | Provider UUID |
name | string | no | Display name |
issuer_url | string | no | OIDC issuer URL |
client_id | string | no | OIDC client ID |
scopes | string | no | Space-separated scopes |
email_claim | string | no | Email claim name |
subject_claim | string | no | Subject claim name |
group_claim | string | no | Group/role claim name |
group_value | string | no | Required group/role value |
auto_provision | string | no | Auto provision users |
require_email_verified | string | no | Require email_verified |
enabled | string | no | Whether this provider is enabled |
curl -X PUT "$PANEL_URL/api/admin/oidc/providers" \
-H "Authorization: Bearer $FEATHERPANEL_API_KEY" \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-d '{"uuid":"","name":"","issuer_url":"","client_id":"","scopes":"","email_claim":"","subject_claim":"","group_claim":"","group_value":"","auto_provision":"","require_email_verified":"","enabled":""}'Plugin events: featherpanel:oidc:provider:create
Responses: 200 Provider created successfully · 400 Bad request
PATCH/api/admin/oidc/providers/{uuid}
Update OIDC provider
| Parameter | In | Type | Required | Description |
|---|---|---|---|---|
uuid | path | string | yes |
Request body: OidcProvider (application/json)
| Body field | Type | Required | Description |
|---|---|---|---|
uuid | string (uuid) | no | Provider UUID |
name | string | no | Display name |
issuer_url | string | no | OIDC issuer URL |
client_id | string | no | OIDC client ID |
scopes | string | no | Space-separated scopes |
email_claim | string | no | Email claim name |
subject_claim | string | no | Subject claim name |
group_claim | string | no | Group/role claim name |
group_value | string | no | Required group/role value |
auto_provision | string | no | Auto provision users |
require_email_verified | string | no | Require email_verified |
enabled | string | no | Whether this provider is enabled |
curl -X PATCH "$PANEL_URL/api/admin/oidc/providers/$UUID" \
-H "Authorization: Bearer $FEATHERPANEL_API_KEY" \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-d '{"uuid":"","name":"","issuer_url":"","client_id":"","scopes":"","email_claim":"","subject_claim":"","group_claim":"","group_value":"","auto_provision":"","require_email_verified":"","enabled":""}'Plugin events: featherpanel:oidc:provider:update
Responses: 200 Provider updated successfully · 404 Provider not found
DELETE/api/admin/oidc/providers/{uuid}
Delete OIDC provider
| Parameter | In | Type | Required | Description |
|---|---|---|---|---|
uuid | path | string | yes |
curl -X DELETE "$PANEL_URL/api/admin/oidc/providers/$UUID" \
-H "Authorization: Bearer $FEATHERPANEL_API_KEY" \
-H "Accept: application/json"Plugin events: featherpanel:oidc:provider:delete
Responses: 200 Provider deleted successfully · 404 Provider not found