GithubActionsOidcClient (sigstore-java 1.2.0 API)

java.lang.Object
- dev.sigstore.oidc.client.GithubActionsOidcClient

All Implemented Interfaces:

OidcClient
```
public class GithubActionsOidcClient
extends java.lang.Object
implements OidcClient
```
Obtain an oidc token from the github execution environment. https://docs.github.com/en/actions/deployment/security-hardening-your-deployments/about-security-hardening-with-openid-connect

Nested Class Summary

Nested Classes
Modifier and Type Class Description

static class GithubActionsOidcClient.Builder

static class GithubActionsOidcClient.GithubOidcJsonResponse

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`static GithubActionsOidcClient.Builder`	`builder()`
`OidcToken`	`getIDToken(java.util.Map<java.lang.String,java.lang.String> env)`
`boolean`	`isEnabled(java.util.Map<java.lang.String,java.lang.String> env)`	Determine if this client can be used in the current environment.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Method Detail
  - builder
```
public static GithubActionsOidcClient.Builder builder()
```
  - isEnabled
```
public boolean isEnabled(java.util.Map<java.lang.String,java.lang.String> env)
```
    Description copied from interface: OidcClient
    
    Determine if this client can be used in the current environment. For example, we can ignore Oidc Clients that are scoped to a specific CI environment
    
    Specified by:
    
    isEnabled in interface OidcClient
    
    Parameters:
    
    env - the configured system environment
    
    Returns:
    
    true if we should use credentials from this client
  - getIDToken
```
public OidcToken getIDToken(java.util.Map<java.lang.String,java.lang.String> env)
                     throws OidcException
```
    Specified by:
    
    getIDToken in interface OidcClient
    
    Throws:
    
    OidcException