AuthEntries.OAuth20AuthEntry (ReadyAPI functional (soapui) SDK 3.20.1)

OAuthCommonAuthEntry

All Superinterfaces:

OAuthCommonAuthEntry

Encapsulates values associated with an Oauth2 flow. Mostly they will be input by users, but the "accessToken" and "status" properties will be modified during the OAuth2 interactions.

Nested Class Summary

Nested classes
Modifiers	Name	Description
`interface`	`AuthEntries.OAuth20AuthEntry.Legacy`

Field Summary

Fields
Modifiers	Name	Description
`java.lang.String`	`APPLY_JWT_ASSERTION_PROPERTY`
`java.lang.String`	`CLIENT_ID_PROPERTY`
`java.lang.String`	`CLIENT_SECRET_PROPERTY`
`java.lang.String`	`ENABLE_PKCE_PROPERTY`
`java.lang.String`	`ID_TOKEN_PROPERTY`
`java.lang.String`	`ID_TOKEN_STATUS_PROPERTY`
`java.lang.String`	`JAVA_SCRIPTS_PROPERTY`
`java.lang.String`	`JWT_ASSERTION_PROPERTY`
`java.lang.String`	`JWT_ENTRY_PROPERTY`
`java.lang.String`	`OAUTH2_FLOW_DISPLAY_STRING_PROPERTY`
`java.lang.String`	`OAUTH2_FLOW_PROPERTY`
`java.lang.String`	`PKCE_CODE_CHALLENGE_METHOD_PROPERTY`
`java.lang.String`	`REFRESH_ACCESS_TOKEN_METHOD_PROPERTY`
`java.lang.String`	`REFRESH_TOKEN_PROPERTY`
`java.lang.String`	`RESOURCE_OWNER_LOGIN_PROPERTY`
`java.lang.String`	`RESOURCE_OWNER_PASSWORD_PROPERTY`
`java.lang.String`	`RESPONSE_TYPE_PROPERTY`
`java.lang.String`	`SCOPE_PROPERTY`
`java.lang.String`	`STATE_PROPERTY`
`java.lang.String`	`USE_AUTH_HEADER_PROPERTY`
`java.lang.String`	`USE_NONCE_PROPERTY`

Methods Summary

Methods
Type Params	Return Type	Name and description
	`void`	`applyRetrievedAccessToken(java.lang.String accessToken)`
	`void`	`applyRetrievedIdToken(java.lang.String idToken)`
	`long`	`getAccessTokenExpirationTime()`
	`boolean`	`getApplyJwtAssertion()`
	`java.util.List<java.lang.String>`	`getAutomationJavaScripts()`
	`java.lang.String`	`getClientID()`
	`java.lang.String`	`getClientSecret()`
	`java.lang.String`	`getIdToken()`
	`Enum`	`getIdTokenStartingStatus()`
	`Enum`	`getIdTokenStatus()`
	`java.lang.String`	`getJwtAssertion()`
	`JwtEntry`	`getJwtEntry()`
	`java.lang.String`	`getLastAccessTokenResponse()`
	`Enum`	`getOAuth2Flow()`
	`java.lang.String`	`getOAuth2FlowDisplayString()`
	`java.lang.String`	`getPKCECodeChallengeMethod()`
	`Enum`	`getRefreshAccessTokenMethod()`
	`java.lang.String`	`getRefreshToken()`
	`java.lang.String`	`getResourceOwnerName()`
	`java.lang.String`	`getResourceOwnerPassword()`
	`Enum`	`getResponseType()`
	`java.lang.String`	`getResponseTypeDisplayString()`
	`java.lang.String`	`getScope()`
	`java.lang.String`	`getState()`
	`boolean`	`getUseAuthHeader()`
	`boolean`	`getUseNonce()`
	`boolean`	`hasAutomationJavaScripts()`
	`boolean`	`isEnablePKCE()`
	`void`	`resetAccessTokenStatusToStartingStatus()`
	`void`	`resetIdTokenStatusToStartingStatus()`
	`void`	`setAccessTokenExpirationTime(long newExpirationTime)`
	`void`	`setApplyJwtAssertion(boolean applyJwtAssertion)`
	`void`	`setAutomationJavaScripts(java.util.List<java.lang.String> javaScripts)`
	`void`	`setClientID(java.lang.String clientID)`
	`void`	`setClientSecret(java.lang.String clientSecret)`
	`void`	`setEnablePKCE(boolean enablePKCE)`
	`void`	`setIdToken(java.lang.String idToken)`
	`void`	`setIdTokenStartingStatus(Enum startingStatus)`
	`void`	`setIdTokenStatus(Enum newStatus)`
	`void`	`setJwtAssertion(java.lang.String jwtValue)`
	`void`	`setJwtEntry(JwtEntry jwtEntry)`
	`void`	`setLastAccessTokenResponse(java.lang.String lastAccessTokenResponse)`
	`void`	`setOAuth2Flow(Enum oauth2Flow)`
	`void`	`setOAuth2FlowDisplayString(java.lang.String value)`
	`void`	`setPKCECodeChallengeMethod(java.lang.String PKCEMethod)`
	`void`	`setRefreshAccessTokenMethod(Enum newRefreshAccessTokenMethod)`
	`void`	`setRefreshToken(java.lang.String refreshToken)`
	`void`	`setResourceOwnerName(java.lang.String name)`
	`void`	`setResourceOwnerPassword(java.lang.String password)`
	`void`	`setResponseType(Enum responseType)`
	`void`	`setResponseTypeDisplayString(java.lang.String value)`
	`void`	`setScope(java.lang.String scope)`
	`void`	`setState(java.lang.String state)`
	`void`	`setUseAuthHeader(boolean useAuthHeader)`
	`void`	`setUseNonce(boolean useNonce)`
	`boolean`	`shouldReloadAccessTokenAutomatically()`
	`void`	`waitForAccessTokenStatus(Enum accessTokenStatus, int timeout)`

- Field Detail
  - public java.lang.String APPLY_JWT_ASSERTION_PROPERTY
  - public java.lang.String CLIENT_ID_PROPERTY
  - public java.lang.String CLIENT_SECRET_PROPERTY
  - public java.lang.String ENABLE_PKCE_PROPERTY
  - public java.lang.String ID_TOKEN_PROPERTY
  - public java.lang.String ID_TOKEN_STATUS_PROPERTY
  - public java.lang.String JAVA_SCRIPTS_PROPERTY
  - public java.lang.String JWT_ASSERTION_PROPERTY
  - public java.lang.String JWT_ENTRY_PROPERTY
  - public java.lang.String OAUTH2_FLOW_DISPLAY_STRING_PROPERTY
  - public java.lang.String OAUTH2_FLOW_PROPERTY
  - public java.lang.String PKCE_CODE_CHALLENGE_METHOD_PROPERTY
  - public java.lang.String REFRESH_ACCESS_TOKEN_METHOD_PROPERTY
  - public java.lang.String REFRESH_TOKEN_PROPERTY
  - public java.lang.String RESOURCE_OWNER_LOGIN_PROPERTY
  - public java.lang.String RESOURCE_OWNER_PASSWORD_PROPERTY
  - public java.lang.String RESPONSE_TYPE_PROPERTY
  - public java.lang.String SCOPE_PROPERTY
  - public java.lang.String STATE_PROPERTY
  - public java.lang.String USE_AUTH_HEADER_PROPERTY
  - public java.lang.String USE_NONCE_PROPERTY
- Method Detail
  - public void applyRetrievedAccessToken(java.lang.String accessToken)
  - public void applyRetrievedIdToken(java.lang.String idToken)
  - public long getAccessTokenExpirationTime()
  - public boolean getApplyJwtAssertion()
  - public java.util.List<java.lang.String> getAutomationJavaScripts()
  - public java.lang.String getClientID()
  - public java.lang.String getClientSecret()
  - public java.lang.String getIdToken()
  - public Enum getIdTokenStartingStatus()
  - public Enum getIdTokenStatus()
  - public java.lang.String getJwtAssertion()
  - public JwtEntry getJwtEntry()
  - public java.lang.String getLastAccessTokenResponse()
  - public Enum getOAuth2Flow()
  - public java.lang.String getOAuth2FlowDisplayString()
  - public java.lang.String getPKCECodeChallengeMethod()
  - public Enum getRefreshAccessTokenMethod()
  - public java.lang.String getRefreshToken()
  - public java.lang.String getResourceOwnerName()
  - public java.lang.String getResourceOwnerPassword()
  - public Enum getResponseType()
  - public java.lang.String getResponseTypeDisplayString()
  - public java.lang.String getScope()
  - public java.lang.String getState()
  - public boolean getUseAuthHeader()
  - public boolean getUseNonce()
  - public boolean hasAutomationJavaScripts()
  - public boolean isEnablePKCE()
  - public void resetAccessTokenStatusToStartingStatus()
  - public void resetIdTokenStatusToStartingStatus()
  - public void setAccessTokenExpirationTime(long newExpirationTime)
  - public void setApplyJwtAssertion(boolean applyJwtAssertion)
  - public void setAutomationJavaScripts(java.util.List<java.lang.String> javaScripts)
  - public void setClientID(java.lang.String clientID)
  - public void setClientSecret(java.lang.String clientSecret)
  - public void setEnablePKCE(boolean enablePKCE)
  - public void setIdToken(java.lang.String idToken)
  - public void setIdTokenStartingStatus(Enum startingStatus)
  - public void setIdTokenStatus(Enum newStatus)
  - public void setJwtAssertion(java.lang.String jwtValue)
  - public void setJwtEntry(JwtEntry jwtEntry)
  - public void setLastAccessTokenResponse(java.lang.String lastAccessTokenResponse)
  - public void setOAuth2Flow(Enum oauth2Flow)
  - public void setOAuth2FlowDisplayString(java.lang.String value)
  - public void setPKCECodeChallengeMethod(java.lang.String PKCEMethod)
  - public void setRefreshAccessTokenMethod(@Nonnull Enum newRefreshAccessTokenMethod)
  - public void setRefreshToken(java.lang.String refreshToken)
  - public void setResourceOwnerName(java.lang.String name)
  - public void setResourceOwnerPassword(java.lang.String password)
  - public void setResponseType(Enum responseType)
  - public void setResponseTypeDisplayString(java.lang.String value)
  - public void setScope(java.lang.String scope)
  - public void setState(java.lang.String state)
  - public void setUseAuthHeader(boolean useAuthHeader)
  - public void setUseNonce(boolean useNonce)
  - public boolean shouldReloadAccessTokenAutomatically()
  - public void waitForAccessTokenStatus(Enum accessTokenStatus, int timeout)

Summary:
Nested
Field
Method

| Detail:
Field
Method

ReadyAPI functional (soapui) SDK 3.20.1

[Java] Interface OAuth20AuthEntry

Nested Class Summary

Field Summary

Methods Summary

Field Detail

public java.lang.String APPLY_JWT_ASSERTION_PROPERTY

public java.lang.String CLIENT_ID_PROPERTY

public java.lang.String CLIENT_SECRET_PROPERTY

public java.lang.String ENABLE_PKCE_PROPERTY

public java.lang.String ID_TOKEN_PROPERTY

public java.lang.String ID_TOKEN_STATUS_PROPERTY

public java.lang.String JAVA_SCRIPTS_PROPERTY

public java.lang.String JWT_ASSERTION_PROPERTY

public java.lang.String JWT_ENTRY_PROPERTY

public java.lang.String OAUTH2_FLOW_DISPLAY_STRING_PROPERTY

public java.lang.String OAUTH2_FLOW_PROPERTY

public java.lang.String PKCE_CODE_CHALLENGE_METHOD_PROPERTY

public java.lang.String REFRESH_ACCESS_TOKEN_METHOD_PROPERTY

public java.lang.String REFRESH_TOKEN_PROPERTY

public java.lang.String RESOURCE_OWNER_LOGIN_PROPERTY

public java.lang.String RESOURCE_OWNER_PASSWORD_PROPERTY

public java.lang.String RESPONSE_TYPE_PROPERTY

public java.lang.String SCOPE_PROPERTY

public java.lang.String STATE_PROPERTY

public java.lang.String USE_AUTH_HEADER_PROPERTY

public java.lang.String USE_NONCE_PROPERTY

Method Detail

public void applyRetrievedAccessToken(java.lang.String accessToken)

public void applyRetrievedIdToken(java.lang.String idToken)

public long getAccessTokenExpirationTime()

public boolean getApplyJwtAssertion()

public java.util.List<java.lang.String> getAutomationJavaScripts()

public java.lang.String getClientID()

public java.lang.String getClientSecret()

public java.lang.String getIdToken()

public Enum getIdTokenStartingStatus()

public Enum getIdTokenStatus()

public java.lang.String getJwtAssertion()

public JwtEntry getJwtEntry()

public java.lang.String getLastAccessTokenResponse()

public Enum getOAuth2Flow()

public java.lang.String getOAuth2FlowDisplayString()

public java.lang.String getPKCECodeChallengeMethod()

public Enum getRefreshAccessTokenMethod()

public java.lang.String getRefreshToken()

public java.lang.String getResourceOwnerName()

public java.lang.String getResourceOwnerPassword()

public Enum getResponseType()

public java.lang.String getResponseTypeDisplayString()

public java.lang.String getScope()

public java.lang.String getState()

public boolean getUseAuthHeader()

public boolean getUseNonce()

public boolean hasAutomationJavaScripts()

public boolean isEnablePKCE()

public void resetAccessTokenStatusToStartingStatus()

public void resetIdTokenStatusToStartingStatus()

public void setAccessTokenExpirationTime(long newExpirationTime)

public void setApplyJwtAssertion(boolean applyJwtAssertion)

public void setAutomationJavaScripts(java.util.List<java.lang.String> javaScripts)

public void setClientID(java.lang.String clientID)

public void setClientSecret(java.lang.String clientSecret)

public void setEnablePKCE(boolean enablePKCE)

public void setIdToken(java.lang.String idToken)

public void setIdTokenStartingStatus(Enum startingStatus)

public void setIdTokenStatus(Enum newStatus)

public void setJwtAssertion(java.lang.String jwtValue)

public void setJwtEntry(JwtEntry jwtEntry)

public void setLastAccessTokenResponse(java.lang.String lastAccessTokenResponse)

public void setOAuth2Flow(Enum oauth2Flow)

public void setOAuth2FlowDisplayString(java.lang.String value)

public void setPKCECodeChallengeMethod(java.lang.String PKCEMethod)

public void setRefreshAccessTokenMethod(@Nonnull Enum newRefreshAccessTokenMethod)

public void setRefreshToken(java.lang.String refreshToken)

public void setResourceOwnerName(java.lang.String name)

public void setResourceOwnerPassword(java.lang.String password)

public void setResponseType(Enum responseType)

public void setResponseTypeDisplayString(java.lang.String value)

public void setScope(java.lang.String scope)

public void setState(java.lang.String state)