oidc-agent
  • Introduction
  • Quickstart
  • Migrating to oidc-agent 5
  • Installation
    • Linux
    • MacOS
    • Windows
  • Configuration
    • oidc-agent Directory
    • General Configuration
    • Custom Request Parameter
    • Configuration of Providers
    • oidc-agent Integration
    • Agent Forwarding
  • Usage
    • oidc-agent
      • Starting oidc-agent
      • General Usage
      • Detailed Information About All Options
    • oidc-agent-service
    • oidc-keychain
      • General Usage
      • Detailed Information About All Options
    • oidc-gen
      • General Usage
      • Detailed Information About All Options
      • Integrate With Different Providers
        • B2Access
        • EGI
        • Elixir
        • Google
        • HBP
        • Helmholtz AAI
        • IAM (INDIGO/DEEP)
        • KIT
        • Any Other Provider
        • Known Issues
        • Client Configuration Values
    • oidc-add
      • General Usage
      • Detailed Information About All Options
    • oidc-token
      • General Usage
      • Detailed Information About All Options
    • oidc-tokensh
      • General Usage
      • Detailed Information About All Options
    • Other Applications Using oidc-agent
    • Tips
    • oidc-agent-server
  • Windows
    • Installation
  • MAC OS
    • State of Feature Support
    • Installation
  • Security
    • Privilege Separation & Architecture
    • Account Configuration Files
    • Credentials
    • Memory
    • Agent Locking
    • Communication
    • Encryption Passwords
    • Autounload (Lifetime)
    • User Confirmation
    • Tracing
    • seccomp
    • Final Note
  • API
    • liboidc-agent4
    • liboidcagent-go
    • liboidcagent-py
    • IPC-API
Powered by GitBook
On this page
  1. Configuration

Custom Request Parameter

Since version 5.2.0 it is possible to customize the requests send by the agent to the OPs and add custom request parameters.

Custom parameters can be configured in a config file named custom_parameters.config. As usual the file can be placed in /etc/oidc-agent or the agent directory. If both are present parameters are merged together.

The custom_parameters.config contains a json array of parameter specifications. A parameter specification is a json object that can have the following fields:

Field Name
Description

parameter

The name of the parameter to be added to the request

value

The value that should be used. The value can be given in different ways. If the value starts with a $ the following characters are interpreted as an environment variable and the value is read from this variable. If the given value starts with an / it is interpreted as a file path and the first line from that file is used as the value. Otherwise the value is used directly.

for_issuer

A JSON array of issuer urls for which this parameter should be used

for_account

A JSON array of account shortnames for which this parameter should be used

request

A JSON array of requests for which this parameter should be used. Possible values are refresh, auth_url, code-exchange,device-init,device-polling,registration,revocation,password

PreviousGeneral ConfigurationNextConfiguration of Providers

Last updated 8 months ago