# login

The `login` command is the primary command to store a user token from an Identity Provider (e.g. GitHub)

If no arguments are provided, it will assume a login is requested for GitHub.

Examples:

* `saml-to login`
  * Functionally equivalent to `saml-to login github`
* `saml-to login github`
  * Begins the process for a GitHub User Token and requests a `user:email` scope 

## Usage

```
saml-to login [provider]

Login to a provider

Options:
  --help       Show help  [boolean]
  --version    Show version number  [boolean]
  --provider   The provider for which to login  [string]
  --org        Specify an organization  [string]
  --withToken  Skip Device Authentication and save the provided token to ~/.saml-to/  [string]
```

## Example Output

Following these commands, a browser window would be opened to begin the SAML Authentication flow.

```
saml-to login github

To continue, we need you to log into GitHub, and we will need the `user:email` scope to access your GitHub Identity.

Please open the browser to https://github.com/login/device and enter the code:

257C-5415


Token cached in: ~/.saml-to/github-token.json
Saved GitHub credentials to ~/.saml-to/github-token.json
```


---

# Agent Instructions: Querying This Documentation

If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter:

```
GET https://docs.saml.to/usage/cli/login.md?ask=<question>
```

The question should be specific, self-contained, and written in natural language.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.