external-auth access-token
Print auth for an external provider
Usage
coder external-auth access-token [flags] <provider>
Description
Print an access-token for an external auth provider. The access-token will be validated and sent to stdout with exit code 0. If a valid access-token cannot be obtained, the URL to authenticate will be sent to stdout with exit code 1
- Ensure that the user is authenticated with GitHub before cloning.:
$ #!/usr/bin/env sh
OUTPUT=$(coder external-auth access-token github)
if [ $? -eq 0 ]; then
echo "Authenticated with GitHub"
else
echo "Please authenticate with GitHub:"
echo $OUTPUT
fi
- Obtain an extra property of an access token for additional metadata.:
$ coder external-auth access-token slack --extra "authed_user.id"
Options
--extra
| Type | string |
Extract a field from the "extra" properties of the OAuth token.
--agent-token
| Type | string |
| Environment | $CODER_AGENT_TOKEN |
An agent authentication token.
--agent-token-file
| Type | string |
| Environment | $CODER_AGENT_TOKEN_FILE |
A file containing an agent authentication token.
--agent-url
| Type | url |
| Environment | $CODER_AGENT_URL |
URL for an agent to access your deployment.
--auth
| Type | string |
| Environment | $CODER_AGENT_AUTH |
| Default | token |
Specify the authentication type to use for the agent.