1OIDC-ADD(1)                      User Commands                     OIDC-ADD(1)
2
3
4

NAME

6       oidc-add - adds account configurations to oidc-agent
7

SYNOPSIS

9       oidc-add [OPTION...] ACCOUNT_SHORTNAME | -a | -l | -x | -X | -R
10

DESCRIPTION

12       oidc-add -- A client for adding and removing accounts to the oidc-agent
13
14              General:
15
16       --always-allow-idtoken Always allow id-token requests without manual
17              approval by the user for this account configuration.
18
19       -a, --loaded
20              Lists the currently loaded account configurations
21
22       -c, --confirm
23              Require user confirmation when an application requests an access
24              token for this configuration
25
26       -f, --force
27              Force to load the account configuration into the agent, even  if
28              it was already loaded.
29
30       -l, --list
31              Lists all configured account configurations
32
33       --pw-cmd=CMD
34              Command from which the agent can read the encryption password
35
36       --pw-env[=OIDC_ENCRYPTION_PW]
37              Reads  the encryption password from the passed environment vari‐
38              able (default: OIDC_ENCRYPTION_PW),  instead  of  prompting  the
39              user
40
41       --pw-file=FILE
42              Uses the first line of FILE as the encryption password.
43
44       --pw-prompt=cli|gui
45              Change  the  mode  how oidc-add should prompt for passwords. The
46              default is 'cli'.
47
48       --pw-store[=TIME]
49              Keeps the encryption password encrypted in memory for TIME  sec‐
50              onds. Default value for TIME: Forever
51
52       -p, --print
53              Prints the encrypted account configuration and exits
54
55       --remote
56              Use a remote central oidc-agent, instead of a local one.
57
58       -r, --remove
59              The account configuration is removed, not added
60
61       -R, --remove-all
62              Removes all account configurations currently loaded
63
64       -t, --lifetime=TIME
65              Set  a  maximum lifetime in seconds when adding the account con‐
66              figuration
67
68       -x, --lock
69              Lock agent
70
71       -X, --unlock
72              Unlock agent
73
74              Verbosity:
75
76       -g, --debug
77              Sets the log level to DEBUG
78
79       -v, --verbose
80              Enables verbose mode
81
82              Help:
83
84       -?, --help
85              Give this help list
86
87       --usage
88              Give a short usage message
89
90       -V, --version
91              Print program version
92
93       Mandatory or optional arguments to long options are also  mandatory  or
94       optional for any corresponding short options.
95

FILES

97       ~/.config/oidc-agent/ or ~/.oidc-agent/
98              oidc-add  reads account and client configurations in this direc‐
99              tory.
100

EXAMPLES

102       oidc-add example
103              Adds the 'example' account configuration to oidc-agent.
104
105       oidc-add example -r
106              Removes the 'example' account configuration from oidc-agent.
107
108       oidc-add example -t 300
109              Adds the 'example' account configuration to oidc-agent. It  will
110              be automatically removed after 5 minutes (300s).
111
112       oidc-add -R
113              Removes all loaded account configurations from oidc-agent.
114
115       oidc-add -x
116              Locks the agent. Use -X to unlock.
117

REPORTING BUGS

119       Report bugs to <https://github.com/indigo-dc/oidc-agent/issues>
120       Subscribe  to  our  mailing  list  to  receive  important updates about
121       oidc-agent:                       <https://www.lists.kit.edu/sympa/sub‐
122       scribe/oidc-agent-user>.
123

SEE ALSO

125       oidc-agent(1), oidc-gen(1), oidc-token(1)
126
127       Low-traffic  mailing  list with updates such as critical security inci‐
128       dents and new releases: https://www.lists.kit.edu/sympa/subscribe/oidc-
129       agent-user
130
131       Full  documentation can be found at https://indigo-dc.gitbooks.io/oidc-
132       agent/user/oidc-add
133
134
135
136oidc-add 5.0.1                  September 2023                     OIDC-ADD(1)