Skip to content

doc: add API docs for v7.0.0 #360

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 2 commits into
base: gh-pages
Choose a base branch
from
Open

doc: add API docs for v7.0.0 #360

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
0c06ea5
doc: add API docs for v7.0.0
oleksandrpravosudko-okta Sep 26, 2022
43e824f
regenerate docs with latest updates
oleksandrpravosudko-okta Sep 29, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
The table of contents is too big for display.
Diff view
Diff view
  •  
  •  
  •  
11 changes: 11 additions & 0 deletions jsdocs/7.0.0/APNSConfiguration.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
# okta.APNSConfiguration

## Properties

Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**fileName** | **string** | (Optional) File name for Admin Console display | [optional] [default to undefined]
**keyId** | **string** | 10-character Key ID obtained from the Apple developer account | [optional] [default to undefined]
**teamId** | **string** | 10-character Team ID used to develop the iOS app | [optional] [default to undefined]
**tokenSigningKey** | **string** | APNs private authentication token signing key | [optional] [default to undefined]

8 changes: 8 additions & 0 deletions jsdocs/7.0.0/APNSPushProvider.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
# okta.APNSPushProvider

## Properties

Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**configuration** | [**APNSConfiguration**](APNSConfiguration.md) | | [optional] [default to undefined]

8 changes: 8 additions & 0 deletions jsdocs/7.0.0/APNSPushProviderAllOf.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
# okta.APNSPushProviderAllOf

## Properties

Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**configuration** | [**APNSConfiguration**](APNSConfiguration.md) | | [optional] [default to undefined]

8 changes: 8 additions & 0 deletions jsdocs/7.0.0/AccessPolicy.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
# okta.AccessPolicy

## Properties

Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**conditions** | [**PolicyRuleConditions**](PolicyRuleConditions.md) | | [optional] [default to undefined]

8 changes: 8 additions & 0 deletions jsdocs/7.0.0/AccessPolicyAllOf.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
# okta.AccessPolicyAllOf

## Properties

Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**conditions** | [**PolicyRuleConditions**](PolicyRuleConditions.md) | | [optional] [default to undefined]

10 changes: 10 additions & 0 deletions jsdocs/7.0.0/AccessPolicyConstraint.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
# okta.AccessPolicyConstraint

## Properties

Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**methods** | **Array<string>** | | [optional] [default to undefined]
**reauthenticateIn** | **string** | | [optional] [default to undefined]
**types** | **Array<string>** | | [optional] [default to undefined]

9 changes: 9 additions & 0 deletions jsdocs/7.0.0/AccessPolicyConstraints.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
# okta.AccessPolicyConstraints

## Properties

Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**knowledge** | [**KnowledgeConstraint**](KnowledgeConstraint.md) | | [optional] [default to undefined]
**possession** | [**PossessionConstraint**](PossessionConstraint.md) | | [optional] [default to undefined]

9 changes: 9 additions & 0 deletions jsdocs/7.0.0/AccessPolicyRule.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
# okta.AccessPolicyRule

## Properties

Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**actions** | [**AccessPolicyRuleActions**](AccessPolicyRuleActions.md) | | [optional] [default to undefined]
**conditions** | [**AccessPolicyRuleConditions**](AccessPolicyRuleConditions.md) | | [optional] [default to undefined]

14 changes: 14 additions & 0 deletions jsdocs/7.0.0/AccessPolicyRuleActions.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,14 @@
# okta.AccessPolicyRuleActions

## Properties

Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**enroll** | [**PolicyRuleActionsEnroll**](PolicyRuleActionsEnroll.md) | | [optional] [default to undefined]
**idp** | [**IdpPolicyRuleAction**](IdpPolicyRuleAction.md) | | [optional] [default to undefined]
**passwordChange** | [**PasswordPolicyRuleAction**](PasswordPolicyRuleAction.md) | | [optional] [default to undefined]
**selfServicePasswordReset** | [**PasswordPolicyRuleAction**](PasswordPolicyRuleAction.md) | | [optional] [default to undefined]
**selfServiceUnlock** | [**PasswordPolicyRuleAction**](PasswordPolicyRuleAction.md) | | [optional] [default to undefined]
**signon** | [**OktaSignOnPolicyRuleSignonActions**](OktaSignOnPolicyRuleSignonActions.md) | | [optional] [default to undefined]
**appSignOn** | [**AccessPolicyRuleApplicationSignOn**](AccessPolicyRuleApplicationSignOn.md) | | [optional] [default to undefined]

8 changes: 8 additions & 0 deletions jsdocs/7.0.0/AccessPolicyRuleActionsAllOf.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
# okta.AccessPolicyRuleActionsAllOf

## Properties

Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**appSignOn** | [**AccessPolicyRuleApplicationSignOn**](AccessPolicyRuleApplicationSignOn.md) | | [optional] [default to undefined]

9 changes: 9 additions & 0 deletions jsdocs/7.0.0/AccessPolicyRuleAllOf.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
# okta.AccessPolicyRuleAllOf

## Properties

Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**actions** | [**AccessPolicyRuleActions**](AccessPolicyRuleActions.md) | | [optional] [default to undefined]
**conditions** | [**AccessPolicyRuleConditions**](AccessPolicyRuleConditions.md) | | [optional] [default to undefined]

9 changes: 9 additions & 0 deletions jsdocs/7.0.0/AccessPolicyRuleApplicationSignOn.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
# okta.AccessPolicyRuleApplicationSignOn

## Properties

Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**access** | **string** | | [optional] [default to undefined]
**verificationMethod** | [**VerificationMethod**](VerificationMethod.md) | | [optional] [default to undefined]

30 changes: 30 additions & 0 deletions jsdocs/7.0.0/AccessPolicyRuleConditions.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,30 @@
# okta.AccessPolicyRuleConditions

## Properties

Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**app** | [**AppAndInstancePolicyRuleCondition**](AppAndInstancePolicyRuleCondition.md) | | [optional] [default to undefined]
**apps** | [**AppInstancePolicyRuleCondition**](AppInstancePolicyRuleCondition.md) | | [optional] [default to undefined]
**authContext** | [**PolicyRuleAuthContextCondition**](PolicyRuleAuthContextCondition.md) | | [optional] [default to undefined]
**authProvider** | [**PasswordPolicyAuthenticationProviderCondition**](PasswordPolicyAuthenticationProviderCondition.md) | | [optional] [default to undefined]
**beforeScheduledAction** | [**BeforeScheduledActionPolicyRuleCondition**](BeforeScheduledActionPolicyRuleCondition.md) | | [optional] [default to undefined]
**clients** | [**ClientPolicyCondition**](ClientPolicyCondition.md) | | [optional] [default to undefined]
**context** | [**ContextPolicyRuleCondition**](ContextPolicyRuleCondition.md) | | [optional] [default to undefined]
**device** | [**DeviceAccessPolicyRuleCondition**](DeviceAccessPolicyRuleCondition.md) | | [optional] [default to undefined]
**grantTypes** | [**GrantTypePolicyRuleCondition**](GrantTypePolicyRuleCondition.md) | | [optional] [default to undefined]
**groups** | [**GroupPolicyRuleCondition**](GroupPolicyRuleCondition.md) | | [optional] [default to undefined]
**identityProvider** | [**IdentityProviderPolicyRuleCondition**](IdentityProviderPolicyRuleCondition.md) | | [optional] [default to undefined]
**mdmEnrollment** | [**MDMEnrollmentPolicyRuleCondition**](MDMEnrollmentPolicyRuleCondition.md) | | [optional] [default to undefined]
**network** | [**PolicyNetworkCondition**](PolicyNetworkCondition.md) | | [optional] [default to undefined]
**people** | [**PolicyPeopleCondition**](PolicyPeopleCondition.md) | | [optional] [default to undefined]
**platform** | [**PlatformPolicyRuleCondition**](PlatformPolicyRuleCondition.md) | | [optional] [default to undefined]
**risk** | [**RiskPolicyRuleCondition**](RiskPolicyRuleCondition.md) | | [optional] [default to undefined]
**riskScore** | [**RiskScorePolicyRuleCondition**](RiskScorePolicyRuleCondition.md) | | [optional] [default to undefined]
**scopes** | [**OAuth2ScopesMediationPolicyRuleCondition**](OAuth2ScopesMediationPolicyRuleCondition.md) | | [optional] [default to undefined]
**userIdentifier** | [**UserIdentifierPolicyRuleCondition**](UserIdentifierPolicyRuleCondition.md) | | [optional] [default to undefined]
**users** | [**UserPolicyRuleCondition**](UserPolicyRuleCondition.md) | | [optional] [default to undefined]
**userStatus** | [**UserStatusPolicyRuleCondition**](UserStatusPolicyRuleCondition.md) | | [optional] [default to undefined]
**elCondition** | [**AccessPolicyRuleCustomCondition**](AccessPolicyRuleCustomCondition.md) | | [optional] [default to undefined]
**userType** | [**UserTypeCondition**](UserTypeCondition.md) | | [optional] [default to undefined]

10 changes: 10 additions & 0 deletions jsdocs/7.0.0/AccessPolicyRuleConditionsAllOf.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
# okta.AccessPolicyRuleConditionsAllOf

## Properties

Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**device** | [**DeviceAccessPolicyRuleCondition**](DeviceAccessPolicyRuleCondition.md) | | [optional] [default to undefined]
**elCondition** | [**AccessPolicyRuleCustomCondition**](AccessPolicyRuleCustomCondition.md) | | [optional] [default to undefined]
**userType** | [**UserTypeCondition**](UserTypeCondition.md) | | [optional] [default to undefined]

8 changes: 8 additions & 0 deletions jsdocs/7.0.0/AccessPolicyRuleCustomCondition.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
# okta.AccessPolicyRuleCustomCondition

## Properties

Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**condition** | **string** | | [optional] [default to undefined]

9 changes: 9 additions & 0 deletions jsdocs/7.0.0/AcsEndpoint.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
# okta.AcsEndpoint

## Properties

Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**index** | **number** | | [optional] [default to undefined]
**url** | **string** | | [optional] [default to undefined]

12 changes: 12 additions & 0 deletions jsdocs/7.0.0/ActivateFactorRequest.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,12 @@
# okta.ActivateFactorRequest

## Properties

Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**attestation** | **string** | | [optional] [default to undefined]
**clientData** | **string** | | [optional] [default to undefined]
**passCode** | **string** | | [optional] [default to undefined]
**registrationData** | **string** | | [optional] [default to undefined]
**stateToken** | **string** | | [optional] [default to undefined]

19 changes: 19 additions & 0 deletions jsdocs/7.0.0/Agent.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,19 @@
# okta.Agent

## Properties

Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**id** | **string** | | [optional] [readonly] [default to undefined]
**isHidden** | **boolean** | | [optional] [default to undefined]
**isLatestGAedVersion** | **boolean** | | [optional] [default to undefined]
**lastConnection** | **Date** | | [optional] [default to undefined]
**name** | **string** | | [optional] [default to undefined]
**operationalStatus** | [**OperationalStatus**](OperationalStatus.md) | | [optional] [default to undefined]
**poolId** | **string** | | [optional] [default to undefined]
**type** | [**AgentType**](AgentType.md) | | [optional] [default to undefined]
**updateMessage** | **string** | | [optional] [default to undefined]
**updateStatus** | [**AgentUpdateInstanceStatus**](AgentUpdateInstanceStatus.md) | | [optional] [default to undefined]
**version** | **string** | | [optional] [default to undefined]
**_links** | [**HrefObject**](HrefObject.md) | | [optional] [default to undefined]

12 changes: 12 additions & 0 deletions jsdocs/7.0.0/AgentPool.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,12 @@
# okta.AgentPool

## Properties

Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**agents** | [**Array<Agent>**](Agent.md) | | [optional] [default to undefined]
**id** | **string** | | [optional] [readonly] [default to undefined]
**name** | **string** | | [optional] [default to undefined]
**operationalStatus** | [**OperationalStatus**](OperationalStatus.md) | | [optional] [default to undefined]
**type** | [**AgentType**](AgentType.md) | | [optional] [default to undefined]

19 changes: 19 additions & 0 deletions jsdocs/7.0.0/AgentPoolUpdate.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,19 @@
# okta.AgentPoolUpdate

## Properties

Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**agents** | [**Array<Agent>**](Agent.md) | | [optional] [default to undefined]
**agentType** | [**AgentType**](AgentType.md) | | [optional] [default to undefined]
**enabled** | **boolean** | | [optional] [default to undefined]
**id** | **string** | | [optional] [readonly] [default to undefined]
**name** | **string** | | [optional] [default to undefined]
**notifyAdmin** | **boolean** | | [optional] [default to undefined]
**reason** | **string** | | [optional] [default to undefined]
**schedule** | [**AutoUpdateSchedule**](AutoUpdateSchedule.md) | | [optional] [default to undefined]
**sortOrder** | **number** | | [optional] [default to undefined]
**status** | [**AgentUpdateJobStatus**](AgentUpdateJobStatus.md) | | [optional] [default to undefined]
**targetVersion** | **string** | | [optional] [default to undefined]
**_links** | [**HrefObject**](HrefObject.md) | | [optional] [default to undefined]

14 changes: 14 additions & 0 deletions jsdocs/7.0.0/AgentPoolUpdateSetting.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,14 @@
# okta.AgentPoolUpdateSetting

## Properties

Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**agentType** | [**AgentType**](AgentType.md) | | [optional] [default to undefined]
**continueOnError** | **boolean** | | [optional] [default to undefined]
**latestVersion** | **string** | | [optional] [default to undefined]
**minimalSupportedVersion** | **string** | | [optional] [default to undefined]
**poolId** | **string** | | [optional] [readonly] [default to undefined]
**poolName** | **string** | | [optional] [default to undefined]
**releaseChannel** | [**ReleaseChannel**](ReleaseChannel.md) | | [optional] [default to undefined]

Loading