Skip to content
Okta Identity Governance
/
Management APIs
/
/
Retrieve a risk rule

Retrieve a risk rule

Request

Beta
OAuth 2.0 scope:
  • okta.governance.riskRule.read
Admin roles:
  • APP_ADMIN

Retrieves a risk rule

Path
ruleIdstringrequired

Unique identifier for the risk rule

GET
/governance/api/v1/risk-rules/{ruleId}
curl -i -X GET \
  'https://okta-subdomain.pixtulate.com/governance/api/v1/risk-rules/{ruleId}'

Responses

Risk rule success response

Headers
X-Rate-Limit-Limitinteger, >= 1required

The rate-limit ceiling for the current request

Example:60
X-Rate-Limit-Remaininginteger, >= 0required

The number of requests left for the current rate-limit window

Example:60
X-Rate-Limit-Resetinteger, >= 0required

The time when the rate limit resets, specified in UTC epoch time (in seconds)

Example:1609459200
Bodyapplication/json
idstring, non-emptyrequired

Unique identifier for the object

descriptionstring, [ 1 .. 1000 ] characters

Description for the risk rule

typestringrequired

Risk rule type

Value:"SEPARATION_OF_DUTIES"
conflictCriteriaobject(conflict-criteria)required

Conflict criteria for the risk rule

createdBystring, (okta-user-id), [ 1 .. 20 ] characters(created-by)read-onlyrequired

The id of the Okta user who created the resource

createdstring, (date-time)(created)read-onlyrequired

The ISO 8601 formatted date and time when the resource was created

lastUpdatedstring, (date-time)(last-updated)read-onlyrequired

The ISO 8601 formatted date and time when the object was last updated

lastUpdatedBystring, (okta-user-id), [ 1 .. 20 ] characters(last-updated-by)read-onlyrequired

The id of the Okta user who last updated the object

namestring, [ 1 .. 255 ] charactersrequired

Name of the resource risk rule

notesstring, [ 1 .. 1000 ] characters

Additional information about the risk rule

resourcesArray of objects, <= 1 items(rule-conflict-resource)required

Resources that the risk rule applies to

statusstringrequired

Status of the risk rule

Enum:"ACTIVE""INVALID"
Response
{
  "id": "rulb0oNGTSWTBKOLGLNR",
  "name": "Process and Approve Payment",
  "description": "Process and Approve Payment",
  "type": "SEPARATION_OF_DUTIES",
  "status": "ACTIVE",
  "resources": [
    { … }
  ],
  "lastUpdated": "2022-05-24T14:15:22Z",
  "createdBy": "00ub0oNGTSWTBKOLGLNR",
  "created": "2022-05-24T14:15:22Z",
  "lastUpdatedBy": "00ub0oNGTSWTBKOLGLNR",
  "conflictCriteria": {
    "and": [ … ]
  },
  "_links": {
    "self": { … }
  }
}