https://github.com/stepzen-dev/stepzen-login
github action for logging into a stepzen server
https://github.com/stepzen-dev/stepzen-login
Last synced: 3 months ago
JSON representation
github action for logging into a stepzen server
- Host: GitHub
- URL: https://github.com/stepzen-dev/stepzen-login
- Owner: stepzen-dev
- License: mit
- Created: 2023-09-28T19:22:02.000Z (over 2 years ago)
- Default Branch: main
- Last Pushed: 2025-08-19T14:00:29.000Z (10 months ago)
- Last Synced: 2025-11-27T09:34:36.432Z (6 months ago)
- Size: 27.3 KB
- Stars: 0
- Watchers: 3
- Forks: 1
- Open Issues: 3
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# stepzen-login
This action logs into the StepZen Server in the specified `domain`, which defaults to `stepzen.net`.
# What's new
Outputs are used instead of environment variables.
# Usage
## Pre-requisites
Node and StepZen CLI must be installed, see [stepzen-dev/stepzen-install action](https://github.com/stepzen-dev/stepzen-install/blob/main/README.md).
## Inputs
- `domain` - StepZen domain (defaults to stepzen.net)
- `account` - StepZen account name
- `instanceid` - API Connect for GraphQL instance identifier
- `adminkey` - Admin key of the StepZen account OR API Connect for GraphQL instance's API key
- `max_attempts` - Number of retry attempts.
- `retry_wait_seconds` - Time to wait between retries in seconds.
- `timeout_seconds` - Seconds to wait before attempt times out.
## Outputs
- `domain` - StepZen domain
- `account` - StepZen account name
- `apikey` - API key for the account (not the admin key)
- `instanceid` - API Connect for GraphQL instance identifier
- `token` - Access token
## Example
- Login using stepzen account and admin key
```yaml
- uses: stepzen-dev/stepzen-login
with:
# StepZen Domain
# Default: 'stepzen.net'
domain: ""
# The StepZen Account to use.
account: ""
# The adminkey of the specified StepZen Account, likely stored in secrets
# [Learn more about creating and using encrypted secrets](https://help.github.com/en/actions/automating-your-workflow-with-github-actions/creating-and-using-encrypted-secrets)
#
# Required.
adminkey: ""
```
- Login using API Connect for GraphQL instance identifier and API key
```yaml
- uses: stepzen-dev/stepzen-login
with:
# StepZen Domain
# Default: 'stepzen.net'
domain: ""
# The API Connect for GraphQL instance identifier to use.
instanceid: ""
# The API Connect for GraphQL instance's API key to use, likely stored in secrets
# [Learn more about creating and using encrypted secrets](https://help.github.com/en/actions/automating-your-workflow-with-github-actions/creating-and-using-encrypted-secrets)
#
# Required.
adminkey: ""
```