Login
Save credentials
beam login [options]
About
The login command will perform a login action and acquire Beamable authorization tokens. There are two main ways Beamable handles authorization, access tokens, and JWTs. JWTs are still being developed. Access tokens are the primary way to handle authorization. Any API request sent to Beamable needs an Authorization
header with a bearer token using the Beamable access token. These tokens are short lived and will need to be refreshed periodically. The login command also issues a refresh token which can be used to fetch a new access token if the need arises.
By default, the login command will not save your access tokens. You should pass the --save-to-file
option to commit the access token and refresh token to your ./beamable
folder.
Options
Name | Type | Description |
---|---|---|
--username | String | Specify user name |
--password | String | User password |
--save-to-environment | Boolean | Save login refresh token to environment variable |
--save-to-file | Boolean | Save login refresh token to file |
--customer-scoped | Boolean | Make request customer scoped instead of product only |
--refresh-token | String | Refresh token to use for the requests |
--print-to-console | Boolean | Prints out login request response to console |
--dryrun | Boolean | Should any networking happen? |
--cid | String | Cid to use; will default to whatever is in the file system |
--pid | String | Pid to use; will default to whatever is in the file system |
--host | String | The host endpoint for beamable |
--refresh-token | String | Refresh token to use for the requests |
--log | String | Extra logs gets printed out |
--dir | String | Directory to use for configuration |
--version | Boolean | Show version information |
--help | Boolean | Show help and usage information |
Updated about 17 hours ago