Package com.ngrok

Class Http.OIDC

java.lang.Object

com.ngrok.Http.OIDC

Enclosing interface:

Http

public static class Http.OIDC
extends Object

Represents OIDC configuration for an HTTP listener.

See Also:

OpenID Connect in the ngrok docs for additional details.

Constructor Summary

Constructors

Constructor	Description
OIDC(String issuerUrl, String clientId, String clientSecret)	Constructs a new OIDC configuration with the specified issuer URL, client ID, and client secret.

Method Summary

Modifier and Type	Method	Description
Http.OIDC	allowDomain(String domain)	Sets the domain that will be allowed by OIDC.
Http.OIDC	allowEmail(String email)	Sets the email address that will be allowed by OIDC.
List<String>	getAllowDomain()	Returns the domain to be allowed by OIDC.
List<String>	getAllowEmail()	Returns the email address to be allowed by OIDC.
String	getClientId()	Returns the client ID for OIDC.
String	getClientSecret()	Returns the client secret for OIDC.
String	getIssuerUrl()	Returns the issuer URL for OIDC.
List<String>	getScope()	Returns the scope to be used by OIDC.
Http.OIDC	scope(String scope)	Sets the scope to be used by OIDC.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

OIDC

public OIDC(String issuerUrl,
            String clientId,
            String clientSecret)

Constructs a new OIDC configuration with the specified issuer URL, client ID, and client secret.

Parameters:

issuerUrl - the issuer URL

clientId - the client ID

clientSecret - the client secret

Method Detail

allowEmail

public Http.OIDC allowEmail(String email)

Sets the email address that will be allowed by OIDC.

Parameters:

email - the email address, unused if null

Returns:

this OIDC object

allowDomain

public Http.OIDC allowDomain(String domain)

Sets the domain that will be allowed by OIDC.

Parameters:

domain - the domain, unused if null

Returns:

this OIDC object

scope

public Http.OIDC scope(String scope)

Sets the scope to be used by OIDC.

Parameters:

scope - the scope, unused if null

Returns:

this OIDC object

getIssuerUrl

public String getIssuerUrl()

Returns the issuer URL for OIDC.

Returns:

the issuer URL

getClientId

public String getClientId()

Returns the client ID for OIDC.

Returns:

the client ID

getClientSecret

public String getClientSecret()

Returns the client secret for OIDC.

Returns:

the client secret

getAllowEmail

public List<String> getAllowEmail()

Returns the email address to be allowed by OIDC.

Returns:

the email address

getAllowDomain

public List<String> getAllowDomain()

Returns the domain to be allowed by OIDC.

Returns:

the domain

getScope

public List<String> getScope()

Returns the scope to be used by OIDC.

Returns:

the scope