Replace the breached credential protection configuration

Request

okta.breachedCredentialProtection.manage

Replaces the breached credential protection configuration for your org

Bodyapplication/jsonrequired

detectionMethodstring(BreachedCredentialDetectionMethod)required

The breach detection method used for breached credential protection

Enum Value	Description
STANDARD	Detects breached credentials using a limited data feed of credentials leaked in third-party breaches. Provides baseline coverage with a lower volume of detections.
ENHANCED	Detects breached credentials using a larger data feed for broader coverage across a wider range of breaches. Provides stronger protection with a higher volume of detections.

PUT

/api/v1/breached-credential-protection/configuration

curl -i -X PUT \
  https://subdomain.okta.com/api/v1/breached-credential-protection/configuration \
  -H 'Content-Type: application/json' \
  -d '{
    "detectionMethod": "STANDARD"
  }'

Responses

OK

Bodyapplication/json

detectionMethodstring(BreachedCredentialDetectionMethod)required

The breach detection method used for breached credential protection

Enum Value	Description
STANDARD	Detects breached credentials using a limited data feed of credentials leaked in third-party breaches. Provides baseline coverage with a lower volume of detections.
ENHANCED	Detects breached credentials using a larger data feed for broader coverage across a wider range of breaches. Provides stronger protection with a higher volume of detections.

_linksobject(LinksSelf)read-only

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.

Response

{
  "detectionMethod": "STANDARD",
  "_links": {
    "self": { … }
  }
}