POST /api/v1/policies
Creates a policy. There are many types of policies that you can create. See Policies for an overview of the types of policies available and then links to more indepth information.
Servers
- https://{yourOktaDomain}
Request headers
| Name | Type | Required | Description |
|---|---|---|---|
Content-Type |
String | Yes |
The media type of the request body.
Default value: "application/json" |
Query parameters
| Name | Type | Required | Description |
|---|---|---|---|
activate |
Boolean | No |
This query parameter is only valid for Classic Engine orgs. Default value: true |
Request body fields
| Name | Type | Required | Description |
|---|---|---|---|
id |
String | No |
Identifier of the Policy Default value: "Assigned" |
_links |
Object | No | |
priority |
Integer | No |
Specifies the order in which this Policy is evaluated in relation to the other policies |
_embedded |
Object | No | |
created |
String | No |
Timestamp when the Policy was created |
name |
String | Yes |
Name of the Policy |
description |
String | No |
Description of the Policy |
system |
Boolean | No |
Specifies whether Okta created the Policy Default value: false |
type |
String | Yes |
All Okta orgs contain only one IdP Discovery Policy with an immutable default Rule routing to your org's sign-in page.
Creating or replacing a policy with the Possible values:
|
status |
String | No |
Possible values:
|
lastUpdated |
String | No |
Timestamp when the Policy was last modified |
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.