awatertrevi/infisical
1
0
Fork 0
mirror of https://github.com/awatertrevi/infisical.git synced 2026-10-06 23:27:14 +00:00
Code Issues Packages Projects Releases Wiki Activity

docs: update login command documentation to include organization-id parameter for direct login

Browse Source
This commit is contained in:
Victor Santos
2025-10-23 11:20:30 -03:00
parent 15bfdf2c5b
commit 3ebd628363
1 changed files with 38 additions and 14 deletions
Download Patch File Download Diff File Expand all files Collapse all files
docs/cli/commands/login.mdx
+38 -14
View File
@@ -49,10 +49,13 @@ User authentication is designed for individual developers and supports multiple
<ParamField query="Flags"> <ParamField query="Flags">
<Expandable title="properties"> <Expandable title="properties">
<ParamField query="email" type="string" optional> <ParamField query="email" type="string" optional>
Your email address. Required for direct login along with `--password`. Your email address. Required for direct login along with `--password` and `--organization-id`.
</ParamField> </ParamField>
<ParamField query="password" type="string" optional> <ParamField query="password" type="string" optional>
Your password. Required for direct login along with `--email`. Your password. Required for direct login along with `--email` and `--organization-id`.
</ParamField>
<ParamField query="organization-id" type="string" optional>
Your organization id. Required for direct login along with `--password` and `--email`.
</ParamField> </ParamField>
<ParamField query="interactive" type="boolean" optional> <ParamField query="interactive" type="boolean" optional>
Force interactive CLI login instead of browser-based authentication. Force interactive CLI login instead of browser-based authentication.
@@ -71,11 +74,12 @@ User authentication is designed for individual developers and supports multiple
</Accordion> </Accordion>
<Accordion title="Direct Login (CI/CD)"> <Accordion title="Direct Login (CI/CD)">
```bash ```bash
infisical login [email protected] --password=your-password infisical login [email protected] --password=your-password --organization-id=your-organization-id
# Or using environment variables # Or using environment variables
export INFISICAL_EMAIL="[email protected]" export INFISICAL_EMAIL="[email protected]"
export INFISICAL_PASSWORD="your-password" export INFISICAL_PASSWORD="your-password"
export INFISICAL_ORGANIZATION_ID="your-organization-id"
infisical login infisical login
``` ```
</Accordion> </Accordion>
@@ -86,7 +90,7 @@ User authentication is designed for individual developers and supports multiple
</Accordion> </Accordion>
<Accordion title="Plain Token Output (Useful for scripting and CI/CD)"> <Accordion title="Plain Token Output (Useful for scripting and CI/CD)">
```bash ```bash
export INFISICAL_TOKEN=$(infisical login [email protected] --password=your-password --plain --silent) export INFISICAL_TOKEN=$(infisical login [email protected] --password=your-password --organization-id=your-organization-id --plain --silent)
``` ```
</Accordion> </Accordion>
</AccordionGroup> </AccordionGroup>
@@ -404,11 +408,11 @@ The login command supports a number of flags that you can use for different auth
</Accordion> </Accordion>
<Accordion title="--email"> <Accordion title="--email">
```bash ```bash
infisical login --email=<email> --password=<password> infisical login --email=<email> --password=<password> --organization-id=<organization-id>
``` ```
#### Description #### Description
User email address. Required if you want to do a non-interactive login when the **--method** flag is set to **user**. Must be used together with the `--password` flag. User email address. Required if you want to do a non-interactive login when the **--method** flag is set to **user**. Must be used together with the `--password` and `--organization-id` flag.
<Tip> <Tip>
You can omit the **--method=user** if you want as it's the default method. You can omit the **--method=user** if you want as it's the default method.
@@ -421,11 +425,11 @@ The login command supports a number of flags that you can use for different auth
</Accordion> </Accordion>
<Accordion title="--password"> <Accordion title="--password">
```bash ```bash
infisical login --email=<email> --password=<password> infisical login --email=<email> --password=<password> --organization-id=<organization-id>
``` ```
#### Description #### Description
User password. Required if you want to do a non-interactive login when the **--method** flag is set to **user**. Must be used together with the `--email` flag. User password. Required if you want to do a non-interactive login when the **--method** flag is set to **user**. Must be used together with the `--email` and `--organization-id` flag.
<Warning> <Warning>
For security in CI/CD environments, prefer using the `INFISICAL_PASSWORD` environment variable instead of passing the password as a command-line flag. For security in CI/CD environments, prefer using the `INFISICAL_PASSWORD` environment variable instead of passing the password as a command-line flag.
@@ -439,6 +443,23 @@ The login command supports a number of flags that you can use for different auth
The `password` flag can be substituted with the `INFISICAL_PASSWORD` environment variable. The `password` flag can be substituted with the `INFISICAL_PASSWORD` environment variable.
</Tip> </Tip>
</Accordion>
<Accordion title="--organization-id">
```bash
infisical login --email=<email> --password=<password> --organization-id=<organization-id>
```
#### Description
User organization id. Required if you want to do a non-interactive login when the **--method** flag is set to **user**. Must be used together with the `--email` and `--password` flag.
<Tip>
You can omit the **--method=user** if you want as it's the default method.
</Tip>
<Tip>
The `organization-id` flag can be substituted with the `INFISICAL_ORGANIZATION_ID` environment variable.
</Tip>
</Accordion> </Accordion>
<Accordion title="--interactive"> <Accordion title="--interactive">
```bash ```bash
@@ -446,12 +467,12 @@ The login command supports a number of flags that you can use for different auth
``` ```
#### Description #### Description
Forces interactive CLI login where you'll be prompted to enter your email and password in the terminal, instead of opening a browser. Forces interactive CLI login where you'll be prompted to enter your email, password, and select your organization in the terminal, instead of opening a browser.
</Accordion> </Accordion>
<Accordion title="--plain"> <Accordion title="--plain">
```bash ```bash
infisical login --email=<email> --password=<password> --plain infisical login --email=<email> --password=<password> --organization-id=<organization-id> --plain
``` ```
#### Description #### Description
@@ -459,7 +480,7 @@ The login command supports a number of flags that you can use for different auth
```bash ```bash
# Example: Capture token in a variable # Example: Capture token in a variable
export INFISICAL_TOKEN=$(infisical login --email=<email> --password=<password> --plain --silent) export INFISICAL_TOKEN=$(infisical login --email=<email> --password=<password> --organization-id=<organization-id> --plain --silent)
``` ```
<Tip> <Tip>
@@ -506,13 +527,13 @@ The following examples demonstrate different ways to authenticate as a user with
```bash ```bash
# Basic direct login (defaults to US Cloud) # Basic direct login (defaults to US Cloud)
infisical login --email [email protected] --password "your-password" infisical login --email [email protected] --password "your-password" --organization-id "your-organization-id"
# EU Cloud (Custom domain) # EU Cloud (Custom domain)
infisical login --email [email protected] --password "your-password" --domain https://eu.infisical.com infisical login --email [email protected] --password "your-password" --organization-id "your-organization-id" --domain https://eu.infisical.com
# Output only JWT token for scripting # Output only JWT token for scripting
export INFISICAL_TOKEN=$(infisical login --email [email protected] --password "your-password" --plain --silent) export INFISICAL_TOKEN=$(infisical login --email [email protected] --password "your-password" --organization-id "your-organization-id" --plain --silent)
``` ```
#### Using Environment Variables (Recommended for CI/CD) #### Using Environment Variables (Recommended for CI/CD)
@@ -521,6 +542,7 @@ The following examples demonstrate different ways to authenticate as a user with
# Set credentials as environment variables # Set credentials as environment variables
export INFISICAL_EMAIL="[email protected]" export INFISICAL_EMAIL="[email protected]"
export INFISICAL_PASSWORD="your-password" export INFISICAL_PASSWORD="your-password"
export INFISICAL_ORGANIZATION_ID="your-organization-id"
# Login without additional flags # Login without additional flags
infisical login infisical login
@@ -542,6 +564,8 @@ The following examples demonstrate different ways to authenticate as a user with
- Email address - Email address
- Password - Password
After the prompt, you will be shown a list of organizations to choose from.
</Accordion> </Accordion>
</AccordionGroup> </AccordionGroup>