OC(1)

πŸ“¦
version 4.22.0 Β· 2 versions
, in nixpkgs unstable

πŸŽ€ OC(1) β€” oc get-token πŸŽ€

okay bestie, welcome to the oc(1) manual page for oc get-token β€” the experimental token-getter that's giving ✨ credential exec plugin ✨. we're going through literally every flag, default, and reference, no skips. πŸ’…

🌸 NAME 🌸

oc get-token β€” Experimental: Get token from external OIDC issuer as credentials exec plugin.

✨ SYNOPSIS ✨

oc get-token [OPTIONS]

πŸ’– DESCRIPTION πŸ’–

Experimental, bestie: this command is under development and may change without notice. It's the built-in Credential Exec plugin of the oc.

It supports Auth Code and Auth Code + PKCE in addition to refresh token. get-token caches the ID token and Refresh token after the auth code flow is successfully completed, and once the ID token expires, the command tries to get the new token by using the refresh token flow. Although it's optional, the command also supports getting a client secret to behave as a confidential client. 🫢

πŸ’… OPTIONS πŸ’…

these are the get-token-specific ones, with the defaults exactly where they belong:

  • --auto-open-browser=false β€” specifies whether the browser is automatically opened or not. default is false, obviously. ✨
  • --callback-address="127.0.0.1:0" β€” Callback address where the external OIDC issuer redirects to after the flow is completed. It defaults to 127.0.0.1:0 to pick a random port.
  • --client-id="" β€” Client ID of the user managed by the external OIDC provider.
  • --client-secret="" β€” Client Secret of the user managed by the external OIDC provider. Optional.
  • --extra-scopes=[] β€” Extra scopes for the auth request to the external OIDC provider. Optional.
  • --issuer-url="" β€” Issuer URL of the external OIDC provider.

🌈 OPTIONS INHERITED FROM PARENT COMMANDS 🌈

these come from the parent command, and yes, they're all here β€” no cap:

  • --as="" β€” Username to impersonate for the operation. User could be a regular user or a service account in a namespace.
  • --as-group=[] β€” Group to impersonate for the operation; this flag can be repeated to specify multiple groups.
  • --as-uid="" β€” UID to impersonate for the operation.
  • --as-user-extra=[] β€” User extras to impersonate for the operation; this flag can be repeated to specify multiple values for the same key.
  • --cache-dir="/homeless-shelter/.kube/cache" β€” Default cache directory.
  • --certificate-authority="" β€” Path to a cert file for the certificate authority.
  • --client-certificate="" β€” Path to a client certificate file for TLS.
  • --client-key="" β€” Path to a client key file for TLS.
  • --cluster="" β€” The name of the kubeconfig cluster to use.
  • --context="" β€” The name of the kubeconfig context to use.
  • --disable-compression=false β€” If true, opt-out of response compression for all requests to the server.
  • --insecure-skip-tls-verify=false β€” If true, the server's certificate will not be checked for validity. This will make your HTTPS connections insecure. ⚠️ like, be so serious about this one, bestie.
  • --kubeconfig="" β€” Path to the kubeconfig file to use for CLI requests.
  • --kuberc="" β€” Path to the kuberc file to use for preferences. This can be disabled by exporting the KUBECTL_KUBERC=false feature gate or turning off the feature KUBERC=off.
  • --match-server-version=false β€” Require server version to match client version.
  • -n, --namespace="" β€” If present, the namespace scope for this CLI request.
  • --profile="none" β€” Name of profile to capture. One of (none|cpu|heap|goroutine|threadcreate|block|mutex).
  • --profile-output="profile.pprof" β€” Name of the file to write the profile to.
  • --request-timeout="0" β€” The length of time to wait before giving up on a single server request. Non-zero values should contain a corresponding time unit (e.g. 1s, 2m, 3h). A value of zero means don't timeout requests.
  • -s, --server="" β€” The address and port of the Kubernetes API server.
  • --tls-server-name="" β€” Server name to use for server certificate validation. If it is not provided, the hostname used to contact the server is used.
  • --token="" β€” Bearer token for authentication to the API server.
  • --user="" β€” The name of the kubeconfig user to use.
  • --warnings-as-errors=false β€” Treat warnings received from the server as errors and exit with a non-zero exit code.

🌟 EXAMPLE 🌟

here's exactly how you'd run it, bestie:

# Starts an auth code flow to the issuer URL with the client ID and the given extra scopes
oc get-token --client-id=client-id --issuer-url=test.issuer.url --extra-scopes=email,profile

# Starts an auth code flow to the issuer URL with a different callback address
oc get-token --client-id=client-id --issuer-url=test.issuer.url --callback-address=127.0.0.1:8343

πŸ¦‹ SEE ALSO πŸ¦‹

The SEE ALSO reference is literally oc(1), β€” yes, trailing comma included. iykyk. πŸ’œ

πŸ•°οΈ HISTORY πŸ•°οΈ

June 2016, Ported from the Kubernetes man-doc generator β€” iconic vintage, honestly. πŸŽ€


okay that's the whole page, bestie πŸ’– source/version: Openshift Β· Openshift CLI User Manuals Β· date: June 2016 Β· manual: OC(1). bye! πŸŽ€βœ¨

πŸ“¦ where this page comes from