def list_tenants(): """ List available tenants """ client = Client() tenants = client.get_available_tenants() output = [] for item in tenants: active = None if item.id == (client.tenant_id or client.get_default_tenant()): active = "*" output.append([item.name, item.slug, item.id, active]) click.echo( tabulate( output, headers=["NAME", "SLUG", "ID", ""], tablefmt="plain", numalign="left", stralign="left", ))
def login(key, token): """ Login to Prefect Cloud Create an API key in the UI then login with it here: $ prefect auth login -k YOUR-KEY You will be switched to the default tenant associated with the key. After login, your available tenants can be seen with `prefect auth list-tenants` and you can change the default tenant on this machine using `prefect auth switch-tenants`. The given key will be stored on disk for later access. Prefect will default to using this key for all interaction with the API but frequently overrides can be passed to individual commands or functions. To remove your key from disk, see `prefect auth logout`. This command has backwards compatibility support for API tokens, which are a deprecated form of authentication with Prefect Cloud """ if not key and not token: raise TerminalError("You must supply an API key or token!") if key and token: raise TerminalError("You cannot supply both an API key and token") abort_on_config_api_key( "To log in with the CLI, remove the config key `prefect.cloud.api_key`" ) # Attempt to treat the input like an API key even if it is passed as a token client = Client(api_key=key or token) try: default_tenant = client.get_default_tenant() except AuthorizationError: if key: # We'll catch an error again later if using a token raise TerminalError("Unauthorized. Invalid Prefect Cloud API key.") except ClientError: raise TerminalError( "Error attempting to communicate with Prefect Cloud.") else: if not default_tenant and key: raise TerminalError( "Failed to find a tenant associated with the given API key!") elif default_tenant: # Successful login if token: click.secho( "WARNING: You logged in with an API key using the `--token` flag " "which is deprecated. Please use `--key` instead.", fg="yellow", ) client.save_auth_to_disk() click.secho("Login successful!", fg="green") return # If there's not a tenant id, we've been given an actual token, fallthrough to # the backwards compatibility token auth # Backwards compatibility for tokens if token: check_override_auth_token() client = Client(api_token=token) # Verify they're not also using an API key if client.api_key: raise TerminalError( "You have already logged in with an API key and cannot use a token." ) click.secho( "WARNING: API tokens are deprecated. Please create an API key and use " "`prefect auth login --key <KEY>` to login instead.", fg="yellow", ) # Verify login obtained a valid api token try: output = client.graphql( query={"query": { "user": { "default_membership": "tenant_id" } }}) # Log into default membership success_login = client.login_to_tenant( tenant_id=output.data.user[0].default_membership.tenant_id) if not success_login: raise AuthorizationError except AuthorizationError: click.secho( "Error attempting to use the given API token. " "Please check that you are providing a USER scoped Personal Access Token.\n" "For more information visit the documentation for USER tokens at " "https://docs.prefect.io/orchestration/concepts/tokens.html#user", fg="red", ) return except ClientError: click.secho( "Error attempting to communicate with Prefect Cloud. " "Please check that you are providing a USER scoped Personal Access Token.\n" "For more information visit the documentation for USER tokens at " "https://docs.prefect.io/orchestration/concepts/tokens.html#user", fg="red", ) return # save token client.save_api_token() click.secho("Login successful!", fg="green")