Package com.konfigyr.gradle

Class KonfigyrExtension.TokenExchangeSpec

java.lang.Object

com.konfigyr.gradle.KonfigyrExtension.TokenExchangeSpec

Enclosing class:

KonfigyrExtension

@NullMarked
public static final class KonfigyrExtension.TokenExchangeSpec
extends Object

Configures a TokenExchange, used for the OAuth2 Token Exchange grant, as defined by RFC 8693.

Since:

1.1.0

See Also:

• KonfigyrExtension.tokenExchange(Action)

Method Summary

Modifier and Type	Method	Description
org.gradle.api.provider.Property<String>	getClientId()	Specify the OAuth client_id that is used to get the OAuth access token.
org.gradle.api.provider.Property<String>	getSubjectToken()	The token being exchanged for an access token.
org.gradle.api.provider.Property<String>	getSubjectTokenType()	An identifier, as defined by RFC 8693, for the type of the subjectToken (for example urn:ietf:params:oauth:token-type:jwt or urn:ietf:params:oauth:token-type:id_token).
boolean	isConfigured()
com.konfigyr.Credentials	toCredentials()

Methods inherited from class java.lang.Object

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

Method Details

isConfigured

public boolean isConfigured()

toCredentials

public com.konfigyr.Credentials toCredentials()

getClientId

public org.gradle.api.provider.Property<String> getClientId()

Specify the OAuth client_id that is used to get the OAuth access token. This value can be specified by the KONFIGYR_CLIENT_ID environment variable.

getSubjectToken

public org.gradle.api.provider.Property<String> getSubjectToken()

The token being exchanged for an access token. This value can be specified by the KONFIGYR_SUBJECT_TOKEN environment variable.

getSubjectTokenType

public org.gradle.api.provider.Property<String> getSubjectTokenType()

An identifier, as defined by RFC 8693, for the type of the subjectToken (for example urn:ietf:params:oauth:token-type:jwt or urn:ietf:params:oauth:token-type:id_token). There is no default value, this must always be set explicitly.