REresilio
AgentAuthentication

Configure OpenID Connect Agent authentication settings

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.

put/agent-authentication/openid

Request

  • Base URL
    https://localhost:8446/api/v2
  • Auth
    API key in header Authorization

Request body

enabledboolean required

Enable/disable OpenID Connect Agent authentication

openid_providerstring

OpenID Connect provider. Required when enabled is true

client_idstring

Client ID. Required when enabled is true

metadata_urlstring

Metadata URL (OpenID Connect discovery document URL). Required when enabled is true

promptstring

Prompt values. Required when enabled is true

callback_portsnumber

Callback ports (integers 1-65535, max 15 entries, unique values). Required when enabled is true

scopestring

Scopes (unique values). Values "openid", "offline_access", "email", "profile" are always included automatically. Required when enabled is true

require_reauthorizationboolean

When enabled, Agents will be required to re-authorize after any OpenID configuration change. Required when enabled is true

Response

Successful response

Changes

No recorded changes to this operation across all 1 revision of this API.