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.
okta.inlineHooks.read
Lists all inline hooks
Success
Forbidden
Too Many Requests
[- {
- "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": {
- "hints": {
- "allow": [
- "DELETE"
]
}, - "href": "string",
- "name": "string",
- "type": "string"
}
}
}
]
okta.inlineHooks.manage
Creates an inline hook
Success
Bad Request
Forbidden
Too Many Requests
{- "channel": {
- "type": "HTTP",
- "version": "string"
}, - "name": "string",
- "status": "ACTIVE",
- "type": "com.okta.import.transform",
- "version": "string"
}
{- "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": {
- "hints": {
- "allow": [
- "DELETE"
]
}, - "href": "string",
- "name": "string",
- "type": "string"
}
}
}
okta.inlineHooks.read
Retrieves an inline hook by inlineHookId
Success
Forbidden
Not Found
Too Many Requests
{- "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": {
- "hints": {
- "allow": [
- "DELETE"
]
}, - "href": "string",
- "name": "string",
- "type": "string"
}
}
}
okta.inlineHooks.manage
Replaces an inline hook by inlineHookId
Success
Bad Request
Forbidden
Not Found
Too Many Requests
{- "channel": {
- "type": "HTTP",
- "version": "string"
}, - "name": "string",
- "status": "ACTIVE",
- "type": "com.okta.import.transform",
- "version": "string"
}
{- "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": {
- "hints": {
- "allow": [
- "DELETE"
]
}, - "href": "string",
- "name": "string",
- "type": "string"
}
}
}
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.
No Content
Forbidden
Not Found
Too Many Requests
{- "errorCode": "E0000006",
- "errorSummary": "You do not have permission to perform the requested action",
- "errorLink": "E0000006",
- "errorId": "sampleNUSD_8fdkFd8fs8SDBK",
- "errorCauses": [ ]
}
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.
Success
Bad Request
Forbidden
Not Found
Too Many Requests
{ }
{- "commands": [
- {
- "type": "string",
- "value": [
- {
- "op": "string",
- "path": "string",
- "value": "string"
}
]
}
]
}
okta.inlineHooks.manage
Activates the inline hook by inlineHookId
Success
Forbidden
Not Found
Too Many Requests
{- "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": {
- "hints": {
- "allow": [
- "DELETE"
]
}, - "href": "string",
- "name": "string",
- "type": "string"
}
}
}
okta.inlineHooks.manage
Deactivates the inline hook by inlineHookId
Success
Forbidden
Not Found
Too Many Requests
{- "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": {
- "hints": {
- "allow": [
- "DELETE"
]
}, - "href": "string",
- "name": "string",
- "type": "string"
}
}
}