Okta.Sdk.Model.TokenHookResponse

October 22, 2025 ยท View on GitHub

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.

Properties

NameTypeDescriptionNotes
CommandsList<TokenHookResponseCommandsInner>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.[optional]
ErrorTokenHookResponseError[optional]

[Back to Model list] [Back to API list] [Back to README]