Skip to content

Commit c4328d2

Browse files
committed
docs: update usage in README
1 parent c18cea4 commit c4328d2

File tree

1 file changed

+28
-19
lines changed

1 file changed

+28
-19
lines changed

README.md

Lines changed: 28 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -7,25 +7,34 @@ Provides a SAML SP authentication proxy for backend web services
77
## Usage
88

99
```text
10-
Usage:
11-
saml-auth-proxy [flags]
12-
13-
Flags:
14-
--attribute-header-mappings stringToString Comma separated list of attribute=header pairs mapping SAML IdP response attributes to forwarded request header [SAML_PROXY_ATTRIBUTE_HEADER_MAPPINGS] (default [])
15-
--authorize-attribute string Enables authorization and specifies the attribute to check for authorized values [SAML_PROXY_AUTHORIZE_ATTRIBUTE]
16-
--authorize-values strings Specifies the possible values that must be present in the authorize attribute [SAML_PROXY_AUTHORIZE_VALUES]
17-
--backend-url string URL of the backend being proxied [SAML_PROXY_BACKEND_URL]
18-
--base-url string External URL of this proxy [SAML_PROXY_BASE_URL]
19-
--bind string host:port to bind for serving HTTP [SAML_PROXY_BIND] (default ":8080")
20-
-h, --help help for saml-auth-proxy
21-
--idp-ca-path string Optional path to a CA certificate PEM file for the IdP [SAML_PROXY_IDP_CA_PATH]
22-
--idp-metadata-url string URL of the IdP's metadata XML [SAML_PROXY_IDP_METADATA_URL]
23-
--name-id-format string One of unspecified, transient (default), email, or persistent to use a standard format or give a full URN of the name ID format [SAML_PROXY_NAME_ID_FORMAT]
24-
--name-id-mapping string Name of the request header to convey the SAML nameID/subject [SAML_PROXY_NAME_ID_MAPPING]
25-
--new-auth-webhook-url string URL of webhook that will get POST'ed when a new authentication is processed [SAML_PROXY_NEW_AUTH_WEBHOOK_URL]
26-
--sp-cert-path string Path to the X509 public certificate PEM file for this SP [SAML_PROXY_SP_CERT_PATH] (default "saml-auth-proxy.cert")
27-
--sp-key-path string Path to the X509 private key PEM file for this SP [SAML_PROXY_SP_KEY_PATH] (default "saml-auth-proxy.key")
28-
--version version for saml-auth-proxy
10+
--attribute-header-mappings value
11+
Comma separated list of attribute=header pairs mapping SAML IdP response attributes to forwarded request header [SAML_PROXY_ATTRIBUTE_HEADER_MAPPINGS]
12+
--authorize-attribute string
13+
Enables authorization and specifies the attribute to check for authorized values [SAML_PROXY_AUTHORIZE_ATTRIBUTE]
14+
--authorize-values value
15+
Specifies the possible values that must be present in the authorize attribute [SAML_PROXY_AUTHORIZE_VALUES]
16+
--backend-url string
17+
URL of the backend being proxied [SAML_PROXY_BACKEND_URL]
18+
--base-url string
19+
External URL of this proxy [SAML_PROXY_BASE_URL]
20+
--bind string
21+
host:port to bind for serving HTTP [SAML_PROXY_BIND] (default ":8080")
22+
--idp-ca-path string
23+
Optional path to a CA certificate PEM file for the IdP [SAML_PROXY_IDP_CA_PATH]
24+
--idp-metadata-url string
25+
URL of the IdP's metadata XML [SAML_PROXY_IDP_METADATA_URL]
26+
--name-id-format string
27+
One of unspecified, transient (default), email, or persistent to use a standard format or give a full URN of the name ID format [SAML_PROXY_NAME_ID_FORMAT]
28+
--name-id-mapping string
29+
Name of the request header to convey the SAML nameID/subject [SAML_PROXY_NAME_ID_MAPPING]
30+
--new-auth-webhook-url string
31+
URL of webhook that will get POST'ed when a new authentication is processed [SAML_PROXY_NEW_AUTH_WEBHOOK_URL]
32+
--sp-cert-path string
33+
Path to the X509 public certificate PEM file for this SP [SAML_PROXY_SP_CERT_PATH] (default "saml-auth-proxy.cert")
34+
--sp-key-path string
35+
Path to the X509 private key PEM file for this SP [SAML_PROXY_SP_KEY_PATH] (default "saml-auth-proxy.key")
36+
--version
37+
show version and exit [SAML_PROXY_VERSION]
2938
```
3039

3140
The snake-case values, such as `SAML_PROXY_BACKEND_URL`, are the equivalent environment variables

0 commit comments

Comments
 (0)