POST /api/v1/captchas
Creates a new CAPTCHA instance. Currently, an org can only configure a single CAPTCHA instance.
Servers
- https://{yourOktaDomain}
Request headers
| Name | Type | Required | Description |
|---|---|---|---|
Content-Type |
String | Yes |
The media type of the request body.
Default value: "application/json" |
Request body fields
| Name | Type | Required | Description |
|---|---|---|---|
id |
String | No |
The unique key for the CAPTCHA instance |
_links |
Object | No |
Specifies link relations (see Web Linking) available using the JSON Hypertext Application Language specification. This object is used for dynamic discovery of related resources and lifecycle operations. |
name |
String | No |
The name of the CAPTCHA instance |
siteKey |
String | No |
The site key issued from the CAPTCHA provider to render a CAPTCHA on a page |
type |
String | No |
The type of CAPTCHA provider Possible values:
|
secretKey |
String | No |
The secret key issued from the CAPTCHA provider to perform server-side validation for a CAPTCHA token |
How to start integrating
- Add HTTP Task to your workflow definition.
- Search for the API you want to integrate with and click on the name.
- This loads the API reference documentation and prepares the Http request settings.
- Click Test request to test run your request to the API and see the API's response.