Package com.okta.sdk.resource.model

Class TokenHookResponse

java.lang.Object

com.okta.sdk.resource.model.TokenHookResponse

All Implemented Interfaces:

Serializable

@Generated(value="org.openapitools.codegen.languages.JavaClientCodegen",
           date="2024-09-23T08:35:59.300824-05:00[America/Chicago]",
           comments="Generator version: 7.8.0")
public class TokenHookResponse
extends Object
implements Serializable

For the token inline hook, the `commands` and `error` objects that you can return in the JSON payload of your response are defined in the following sections. > **Note:** The size of your response payload must be less than 256 KB.

See Also:

• Serialized Form

Field Summary

Fields

Modifier and Type	Field	Description
static final String	JSON_PROPERTY_COMMANDS
static final String	JSON_PROPERTY_ERROR

Constructor Summary

Constructors

Constructor	Description
TokenHookResponse()

Method Summary

Modifier and Type	Method	Description
TokenHookResponse	addcommandsItem(TokenHookResponseCommandsInner commandsItem)
TokenHookResponse	commands(List<TokenHookResponseCommandsInner> commands)
boolean	equals(Object o)
TokenHookResponse	error(TokenHookResponseError error)
List<TokenHookResponseCommandsInner>	getCommands()	You can use the `commands` object to provide commands to Okta.
TokenHookResponseError	getError()	Get error
int	hashCode()
void	setCommands(List<TokenHookResponseCommandsInner> commands)
void	setError(TokenHookResponseError error)
String	toString()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Details

JSON_PROPERTY_COMMANDS

public static final String JSON_PROPERTY_COMMANDS

See Also:

• Constant Field Values

JSON_PROPERTY_ERROR

public static final String JSON_PROPERTY_ERROR

See Also:

• Constant Field Values

Constructor Details

TokenHookResponse

public TokenHookResponse()

Method Details

commands

public TokenHookResponse commands(List<TokenHookResponseCommandsInner> commands)

addcommandsItem

public TokenHookResponse addcommandsItem(TokenHookResponseCommandsInner commandsItem)

getCommands

@Nullable
public List<TokenHookResponseCommandsInner> getCommands()

You can use the `commands` object to provide commands to Okta. It's where you can tell Okta to add more claims to the token. The `commands` object is an array, allowing you to send multiple commands. In each array element, there needs to be a `type` property and `value` property. The `type` property is where you specify which of the supported commands you want to execute, and `value` is where you supply an operand for that command. In the case of the token hook type, the `value` property is itself a nested object in which you specify a particular operation, a path to act on, and a value.

Returns:

commands

setCommands

public void setCommands(List<TokenHookResponseCommandsInner> commands)

error

public TokenHookResponse error(TokenHookResponseError error)

getError

@Nullable
public TokenHookResponseError getError()

Get error

Returns:

error

setError

public void setError(TokenHookResponseError error)

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

toString

public String toString()

Overrides:

toString in class Object