Inline Hooks

The Inline Hooks API provides operations to manage inline hooks for your organization.

For general information on inline hooks and how to create and use them, see inline hooks. The following documentation is only for the management API, which provides a CRUD interface for registering inline hooks.

List all Inline Hooks
OAuth 2.0: okta.inlineHooks.read

Lists all inline hooks

Request
query Parameters
type
string
Responses
200

Success

403

Forbidden

429

Too Many Requests

get/api/v1/inlineHooks
Request samples
Response samples
application/json
[
  • {
    • "channel": {
      },
    • "created": "2019-08-24T14:15:22Z",
    • "id": "string",
    • "lastUpdated": "2019-08-24T14:15:22Z",
    • "name": "string",
    • "status": "ACTIVE",
    • "type": "com.okta.import.transform",
    • "version": "string",
    • "_links": {
      }
    }
]

Create an Inline Hook
OAuth 2.0: okta.inlineHooks.manage

Creates an inline hook

Request
Request Body schema: application/json
object (InlineHookChannel)
type
string (InlineHookChannelType)
version
string
object (InlineHookChannelConfig)
object (InlineHookChannelConfigAuthScheme)
Array of objects (InlineHookChannelConfigHeaders)
method
string
uri
string
name
string
status
string (InlineHookStatus)
Enum: "ACTIVE" "INACTIVE"
type
string (InlineHookType)
Enum: "com.okta.import.transform" "com.okta.oauth2.tokens.transform" "com.okta.saml.tokens.transform" "com.okta.user.credential.password.import" "com.okta.user.pre-registration"
version
string
Responses
200

Success

400

Bad Request

403

Forbidden

429

Too Many Requests

post/api/v1/inlineHooks
Request samples
application/json
{
  • "channel": {
    • "type": "HTTP",
    • "version": "string"
    },
  • "name": "string",
  • "status": "ACTIVE",
  • "type": "com.okta.import.transform",
  • "version": "string"
}
Response samples
application/json
{
  • "channel": {
    • "type": "HTTP",
    • "version": "string"
    },
  • "created": "2019-08-24T14:15:22Z",
  • "id": "string",
  • "lastUpdated": "2019-08-24T14:15:22Z",
  • "name": "string",
  • "status": "ACTIVE",
  • "type": "com.okta.import.transform",
  • "version": "string",
  • "_links": {
    • "self": {
      }
    }
}

Retrieve an Inline Hook
OAuth 2.0: okta.inlineHooks.read

Retrieves an inline hook by inlineHookId

Request
path Parameters
inlineHookId
required
string

id of the Inline Hook

Example: Y7Rzrd4g4xj6WdKzrBHH
Responses
200

Success

403

Forbidden

404

Not Found

429

Too Many Requests

get/api/v1/inlineHooks/{inlineHookId}
Request samples
Response samples
application/json
{
  • "channel": {
    • "type": "HTTP",
    • "version": "string"
    },
  • "created": "2019-08-24T14:15:22Z",
  • "id": "string",
  • "lastUpdated": "2019-08-24T14:15:22Z",
  • "name": "string",
  • "status": "ACTIVE",
  • "type": "com.okta.import.transform",
  • "version": "string",
  • "_links": {
    • "self": {
      }
    }
}

Replace an Inline Hook
OAuth 2.0: okta.inlineHooks.manage

Replaces an inline hook by inlineHookId

Request
path Parameters
inlineHookId
required
string

id of the Inline Hook

Example: Y7Rzrd4g4xj6WdKzrBHH
Request Body schema: application/json
object (InlineHookChannel)
type
string (InlineHookChannelType)
version
string
object (InlineHookChannelConfig)
object (InlineHookChannelConfigAuthScheme)
Array of objects (InlineHookChannelConfigHeaders)
method
string
uri
string
name
string
status
string (InlineHookStatus)
Enum: "ACTIVE" "INACTIVE"
type
string (InlineHookType)
Enum: "com.okta.import.transform" "com.okta.oauth2.tokens.transform" "com.okta.saml.tokens.transform" "com.okta.user.credential.password.import" "com.okta.user.pre-registration"
version
string
Responses
200

Success

400

Bad Request

403

Forbidden

404

Not Found

429

Too Many Requests

put/api/v1/inlineHooks/{inlineHookId}
Request samples
application/json
{
  • "channel": {
    • "type": "HTTP",
    • "version": "string"
    },
  • "name": "string",
  • "status": "ACTIVE",
  • "type": "com.okta.import.transform",
  • "version": "string"
}
Response samples
application/json
{
  • "channel": {
    • "type": "HTTP",
    • "version": "string"
    },
  • "created": "2019-08-24T14:15:22Z",
  • "id": "string",
  • "lastUpdated": "2019-08-24T14:15:22Z",
  • "name": "string",
  • "status": "ACTIVE",
  • "type": "com.okta.import.transform",
  • "version": "string",
  • "_links": {
    • "self": {
      }
    }
}

Delete an Inline Hook
OAuth 2.0: okta.inlineHooks.manage

Deletes an inline hook by inlineHookId. Once deleted, the Inline Hook is unrecoverable. As a safety precaution, only Inline Hooks with a status of INACTIVE are eligible for deletion.

Request
path Parameters
inlineHookId
required
string

id of the Inline Hook

Example: Y7Rzrd4g4xj6WdKzrBHH
Responses
204

No Content

403

Forbidden

404

Not Found

429

Too Many Requests

delete/api/v1/inlineHooks/{inlineHookId}
Request samples
Response samples
application/json
{
  • "errorCode": "E0000006",
  • "errorSummary": "You do not have permission to perform the requested action",
  • "errorLink": "E0000006",
  • "errorId": "sampleNUSD_8fdkFd8fs8SDBK",
  • "errorCauses": [ ]
}

Execute an Inline Hook
OAuth 2.0: okta.inlineHooks.manage

Executes the inline hook by inlineHookId using the request body as the input. This will send the provided data through the Channel and return a response if it matches the correct data contract. This execution endpoint should only be used for testing purposes.

Request
path Parameters
inlineHookId
required
string

id of the Inline Hook

Example: Y7Rzrd4g4xj6WdKzrBHH
Request Body schema: application/json
object (InlineHookPayload)
Responses
200

Success

400

Bad Request

403

Forbidden

404

Not Found

429

Too Many Requests

post/api/v1/inlineHooks/{inlineHookId}/execute
Request samples
application/json
{ }
Response samples
application/json
{
  • "commands": [
    • {
      }
    ]
}

Activate an Inline Hook
OAuth 2.0: okta.inlineHooks.manage

Activates the inline hook by inlineHookId

Request
path Parameters
inlineHookId
required
string

id of the Inline Hook

Example: Y7Rzrd4g4xj6WdKzrBHH
Responses
200

Success

403

Forbidden

404

Not Found

429

Too Many Requests

post/api/v1/inlineHooks/{inlineHookId}/lifecycle/activate
Request samples
Response samples
application/json
{
  • "channel": {
    • "type": "HTTP",
    • "version": "string"
    },
  • "created": "2019-08-24T14:15:22Z",
  • "id": "string",
  • "lastUpdated": "2019-08-24T14:15:22Z",
  • "name": "string",
  • "status": "ACTIVE",
  • "type": "com.okta.import.transform",
  • "version": "string",
  • "_links": {
    • "self": {
      }
    }
}

Deactivate an Inline Hook
OAuth 2.0: okta.inlineHooks.manage

Deactivates the inline hook by inlineHookId

Request
path Parameters
inlineHookId
required
string

id of the Inline Hook

Example: Y7Rzrd4g4xj6WdKzrBHH
Responses
200

Success

403

Forbidden

404

Not Found

429

Too Many Requests

post/api/v1/inlineHooks/{inlineHookId}/lifecycle/deactivate
Request samples
Response samples
application/json
{
  • "channel": {
    • "type": "HTTP",
    • "version": "string"
    },
  • "created": "2019-08-24T14:15:22Z",
  • "id": "string",
  • "lastUpdated": "2019-08-24T14:15:22Z",
  • "name": "string",
  • "status": "ACTIVE",
  • "type": "com.okta.import.transform",
  • "version": "string",
  • "_links": {
    • "self": {
      }
    }
}