---
title: "Configure OpenID Connect Agent authentication settings"
method: PUT
path: "/agent-authentication/openid"
tags: ["AgentAuthentication"]
---

# Configure OpenID Connect Agent authentication settings

`PUT /agent-authentication/openid`

## Request

- Base URL: `https://localhost:8446/api/v2`
- URL: `https://localhost:8446/api/v2/agent-authentication/openid`
- Auth: API key in header `Authorization`

Configure OpenID Connect Agent authentication settings. Returns the updated OpenID Connect Agent authentication settings. See get OpenID Connect Agent authentication settings for the response details. For OpenID Connect configuration details, refer to the OpenID Connect Discovery specification . When enabled is true , all OpenID Connect-specific fields are required. To disable, send { "enabled": false } without any other fields; the stored OpenID Connect settings are reset to defaults.

## Request body

- object
  - `enabled` boolean, required: Enable/disable OpenID Connect Agent authentication
  - `openid_provider` string: OpenID Connect provider. Required when enabled is true
  - `client_id` string: Client ID. Required when enabled is true
  - `metadata_url` string: Metadata URL (OpenID Connect discovery document URL). Required when enabled is true
  - `prompt` string: Prompt values. Required when enabled is true
  - `callback_ports` number: Callback ports (integers 1-65535, max 15 entries, unique values). Required when enabled is true
  - `scope` string: Scopes (unique values). Values "openid", "offline_access", "email", "profile" are always included automatically. Required when enabled is true
  - `require_reauthorization` boolean: When enabled, Agents will be required to re-authorize after any OpenID configuration change. Required when enabled is true

## Response `200`

Successful response

## Other responses

- `default`: Error response. Depending on the error, either a 4xx or 5xx response status is returned.

---

[API](https://skmtc.dev/resilio/apis/resilio-api.md) - [All operations](https://skmtc.dev/resilio/apis/resilio-api/llms.txt) - [OpenAPI document](https://skmtc.dev/resilio/apis/resilio-api/revisions/ca39130a395e?raw)