rattler-build auth login#
Store authentication information for a given host
Usage#
Arguments#
-
<HOST>- The host to authenticate with (e.g. prefix.dev)
required:true
Options#
-
--user-agent <USER_AGENT>- User-Agent header used for requests
OAuth/OIDC Authentication#
-
--oauth- Log in interactively with OAuth/OIDC (browser or device code)
-
--oauth-issuer-url <OAUTH_ISSUER_URL>- OIDC issuer URL (defaults to https://{host})
-
--oauth-client-id <OAUTH_CLIENT_ID>- OAuth client ID (defaults to "rattler")
-
--oauth-client-secret <OAUTH_CLIENT_SECRET>- OAuth client secret (for confidential clients)
-
--oauth-flow <OAUTH_FLOW>- OAuth flow: device-code (default), auth-code, auto
options:device-code,auth-code,auto
-
--oauth-scope <OAUTH_SCOPES>- Additional OAuth scopes to request (repeatable)
May be provided more than once.
-
--oauth-redirect-uri <OAUTH_REDIRECT_URI>- OAuth redirect URI (defaults to a random localhost port). Set this when the OAuth client on the
IdPside is registered with a specific redirect URI such ashttp://127.0.0.1:8000/auth/oidc
-
--oauth-audience <OAUTH_AUDIENCE>- OAuth
audienceto request, so the access token is also accepted by that API (provider-specific)
S3 Authentication#
-
--s3-access-key-id <S3_ACCESS_KEY_ID>- The S3 access key ID
-
--s3-secret-access-key <S3_SECRET_ACCESS_KEY>- The S3 secret access key
-
--s3-session-token <S3_SESSION_TOKEN>- The S3 session token
Token / Basic Authentication#
-
--token <TOKEN>- The token to use (for authentication with prefix.dev)
-
--username <USERNAME>- The username to use (for basic HTTP authentication)
-
--password <PASSWORD>- The password to use (for basic HTTP authentication)
-
--conda-token <CONDA_TOKEN>- The token to use on anaconda.org / quetz authentication
Workload Identity (CI, non-interactive)#
-
--workload-identity- Log in non-interactively by exchanging the CI provider's OIDC ID token (GitHub Actions, GitLab CI, ...) for an access token
-
--workload-identity-audience <WORKLOAD_IDENTITY_AUDIENCE>- Audience requested in the OIDC ID token (defaults to the host, or
prefix.devfor prefix.dev hosts)
-
--workload-identity-exchange <WORKLOAD_IDENTITY_EXCHANGE>- How the server exchanges the ID token (defaults to
prefixfor prefix.dev hosts andtoken-exchangeotherwise)
options:token-exchange,prefix
-
--workload-identity-token-endpoint <WORKLOAD_IDENTITY_TOKEN_ENDPOINT>- Token endpoint for
--workload-identity-exchange token-exchange: a URL or a path on the host (defaults to thetoken_endpointfrom the host's RFC 8414 metadata, or/access/api/v1/oidc/tokenfor *.jfrog.io hosts)