# coder external-auth access-token

Print auth for an external provider

## Usage [#usage]

```console
coder external-auth access-token [flags] <provider>
```

## Description [#description]

```console
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"

  - Print the full token response as JSON.:

     $ coder external-auth access-token github --output json
```

## Options [#options]

### --extra [#--extra]

|      |                     |
| ---- | ------------------- |
| Type | <code>string</code> |

Extract a field from the "extra" properties of the OAuth token.

### --output [#--output]

|         |                         |
| ------- | ----------------------- |
| Type    | <code>text\|json</code> |
| Default | <code>text</code>       |

Output format. Available formats: text, json.

### --agent-token [#--agent-token]

|             |                                   |
| ----------- | --------------------------------- |
| Type        | <code>string</code>               |
| Environment | <code>$CODER\_AGENT\_TOKEN</code> |

An agent authentication token.

### --agent-token-file [#--agent-token-file]

|             |                                         |
| ----------- | --------------------------------------- |
| Type        | <code>string</code>                     |
| Environment | <code>$CODER\_AGENT\_TOKEN\_FILE</code> |

A file containing an agent authentication token.

### --agent-url [#--agent-url]

|             |                                 |
| ----------- | ------------------------------- |
| Type        | <code>url</code>                |
| Environment | <code>$CODER\_AGENT\_URL</code> |

URL for an agent to access your deployment.

### --auth [#--auth]

|             |                                  |
| ----------- | -------------------------------- |
| Type        | <code>string</code>              |
| Environment | <code>$CODER\_AGENT\_AUTH</code> |
| Default     | <code>token</code>               |

Specify the authentication type to use for the agent.

### --agent-name [#--agent-name]

|             |                                  |
| ----------- | -------------------------------- |
| Type        | <code>string</code>              |
| Environment | <code>$CODER\_AGENT\_NAME</code> |

The name of the agent to authenticate as (only applicable for instance identity).