Skip to content

Commit 9ec6603

Browse files
authored
Improved docs to better reflect authenticating to Private Clouds (#1187)
* Updated docs to reflect authenticating to Private Clouds * Added rate limit warning * updated docs
1 parent 68b0b47 commit 9ec6603

File tree

3 files changed

+23
-9
lines changed

3 files changed

+23
-9
lines changed

README.md

Lines changed: 14 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -134,11 +134,22 @@ auth0 login
134134
135135
There are two ways to authenticate:
136136
137-
- **As a user** - Recommended when invoking on a personal machine or other interactive environment. Facilitated by [device authorization](https://auth0.com/docs/get-started/authentication-and-authorization-flow/device-authorization-flow) flow.
138-
- **As a machine** - Recommended when running on a server or non-interactive environments (ex: CI). Facilitated by [client credentials](https://auth0.com/docs/get-started/authentication-and-authorization-flow/client-credentials-flow) flow. Flags available for bypassing interactive shell.
137+
- **As a user** - Recommended when invoking on a personal machine or other interactive environment. Facilitated by [device authorization](https://auth0.com/docs/get-started/authentication-and-authorization-flow/device-authorization-flow) flow and cannot be used for private cloud tenants.
138+
- **As a machine** - Recommended when running on a server or non-interactive environments (ex: CI, authenticating to a **private cloud**). Facilitated by [client credentials](https://auth0.com/docs/get-started/authentication-and-authorization-flow/client-credentials-flow) flow. Flags available for bypassing interactive shell.
139+
140+
139141
140142
> **Warning**
141-
> Authenticating as a user is not supported for **private cloud** tenants. Instead, those users should authenticate with client credentials.
143+
> Authenticating as a user is not supported for **private cloud** tenants.
144+
> Instead, those users should authenticate with client credentials.
145+
> Refer command below:
146+
147+
```bash
148+
auth0 login --domain <domain> --client-id <client-id> --client-secret <client-secret>
149+
```
150+
151+
> **Note:**
152+
> Using the CLI will consume Management API rate limits according to the subscription plan. Ref [Rate limit Policy](https://auth0.com/docs/troubleshoot/customer-support/operational-policies/rate-limit-policy)
142153
143154
## Available Commands
144155

docs/auth0_login.md

Lines changed: 5 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -4,9 +4,12 @@ has_toc: false
44
---
55
# auth0 login
66

7-
Authenticates the Auth0 CLI either as a user using personal credentials or as a machine using client credentials.
7+
Authenticates the Auth0 CLI using either personal credentials (user login) or client credentials (machine login).
8+
9+
Use user login on personal machines or interactive environments (not supported for Private Cloud users).
10+
Use machine login for servers, CI, or any non-interactive environments — this is the recommended method for Private Cloud users.
11+
812

9-
Authenticating as a user is recommended when working on a personal machine or other interactive environment; it is not available for Private Cloud users. Authenticating as a machine is recommended when running on a server or non-interactive environments (ex: CI).
1013

1114
## Usage
1215
```

internal/cli/login.go

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -68,10 +68,10 @@ func loginCmd(cli *cli) *cobra.Command {
6868
Use: "login",
6969
Args: cobra.NoArgs,
7070
Short: "Authenticate the Auth0 CLI",
71-
Long: "Authenticates the Auth0 CLI either as a user using personal credentials or as a machine using client " +
72-
"credentials.\n\nAuthenticating as a user is recommended when working on a personal machine or other " +
73-
"interactive environment; it is not available for Private Cloud users. Authenticating as a machine is " +
74-
"recommended when running on a server or non-interactive environments (ex: CI).",
71+
Long: "Authenticates the Auth0 CLI using either personal credentials (user login) or client credentials (machine login)." +
72+
"\n\nUse user login on personal machines or interactive environments (not supported for Private Cloud users).\n" +
73+
"Use machine login for servers, CI, or any non-interactive environments — " +
74+
"this is the recommended method for Private Cloud users.\n\n",
7575
Example: ` auth0 login
7676
auth0 login --domain <tenant-domain> --client-id <client-id> --client-secret <client-secret>
7777
auth0 login --scopes "read:client_grants,create:client_grants"`,

0 commit comments

Comments
 (0)