# GitHub Action outputs reference

> Complete reference for Aembit GitHub Action outputs and usage examples

Usage and outputs for the Aembit GitHub Action. Content syncs from the [GitHub repository](https://github.com/Aembit/get-credentials) at build time.

## Usage

```yaml
- uses: Aembit/get-credentials@v1
  id: step-id # This is required as output of this step is passed to the next step(s).
  with:
    # Aembit Edge SDK Client ID.
    # The unique identifier for your GitHub Trust Provider in Aembit.
    # You can find it by logging into your Aembit tenant, navigating to Trust Providers, selecting your GitHub Trust Provider, and copying the Edge SDK Client ID.
    # This is a required field.
    client-id: ''


    # Specifies the type of credential to retrieve from Aembit.
    # Valid values are: ApiKey, UsernamePassword, OAuthToken, GoogleWorkloadIdentityFederation, AwsStsFederation
    # This is a required field.
    credential-type: ''


    # Aembit Resource Set ID.
    # Optional. If not specified, the Default Resource Set is used.
    resource-set-id: ''


    # Server Workload - Service Endpoint Host
    # Used to access server workload which in turn is used to access credentials.
    # You can find it by logging into your Aembit tenant, navigating to Server Workloads, selecting your desired Server Workload, and copying the Service Endpoint Host.
    server-host: ''


    # Server Workload - Service Endpoint Port
    # Used to access server workload which in turn is used to access credentials.
    # You can find it by logging into your Aembit tenant, navigating to Server Workloads, selecting your desired Server Workload, and copying the Service Endpoint Port.
    # Default: 443
    server-port: 443
```

### Outputs

The outputs available depend on the `credential-type` specified:

### ApiKey

```yaml
outputs:
    # API key credential
    # Usage: ${{ steps.step-id.outputs.api-key }}
    api-key: '****'
```

### UsernamePassword

```yaml
outputs:
    # Username credential
    # Usage: ${{ steps.step-id.outputs.username }}
    username: '****'


    # Password credential
    # Usage: ${{ steps.step-id.outputs.password }}
    password: '****'
```

### OAuthToken

```yaml
outputs:
    # OAuth token credential
    # Usage: ${{ steps.step-id.outputs.token }}
    token: '****'
```

### GoogleWorkloadIdentityFederation

```yaml
outputs:
    # Google Workload Identity Federation token
    # Usage: ${{ steps.step-id.outputs.token }}
    token: '****'
```

### AwsStsFederation

```yaml
outputs:
    # AWS Access Key ID
    # Usage: ${{ steps.step-id.outputs.aws-access-key-id }}
    aws-access-key-id: '****'


    # AWS Secret Access Key
    # Usage: ${{ steps.step-id.outputs.aws-secret-access-key }}
    aws-secret-access-key: '****'


    # AWS Session Token
    # Usage: ${{ steps.step-id.outputs.aws-session-token }}
    aws-session-token: '****'
```

> **Note**
>
> All the outputs generated by this action are GitHub masked secrets.

## Additional resources

* [GitHub Marketplace listing](https://github.com/marketplace/actions/aembit-get-credentials) - Action installation
* [GitHub repository](https://github.com/Aembit/get-credentials) - Source code and issues
* [How-to guide](/user-guide/deploy-install/ci-cd/github/github-actions-how-to/) - Usage examples with different credential types
* [Tutorial](/user-guide/deploy-install/ci-cd/github/github-actions-tutorial/) - Step-by-step first setup