Jump to

• Request
• Response

Deprecated - Process rules

put

https://oaainstall-host/risk-analyzer/risk/v1/{requestId}

Deprecated:Please use processrulessecurely API. Runs rules for a given session (request) and checkpoint.

Request

Path Parameters

• requestId(required): string

Supported Media Types

• application/xml
• application/json

Request Body - application/xml ()

Root Schema : schema

Type: object

Process rule request object

Show Source

• checkpointList: array checkpointList
  List of checkpoints to be executed. Currently, only one checkpoint per request is supported.
• contextMap: array contextMap
  additional context for rule evaluation.
• extTransactionId: string
  external transaction Id, used only when transactionId is null
• requestId(required): string
  requestId for the request
• requestTime: string (date-time)
  Date time string in the format rfc3339 sec 5.6. https://tools.ietf.org/html/rfc3339#section-5.6 e.g format 2021-08-13T01:29:29.768Z
• transactionId: number
  User Activity data Identifier created for this session

{
    "type":"object",
    "description":"Process rule request object",
    "required":[
        "requestId"
    ],
    "properties":{
        "requestId":{
            "type":"string",
            "description":"requestId for the request"
        },
        "transactionId":{
            "type":"number",
            "description":"User Activity data Identifier created for this session"
        },
        "extTransactionId":{
            "type":"string",
            "description":"external transaction Id, used only when transactionId is null"
        },
        "requestTime":{
            "$ref":"#/components/schemas/DateTime",
            "description":"time of the request"
        },
        "checkpointList":{
            "type":"array",
            "items":{
                "type":"integer"
            },
            "description":"List of checkpoints to be executed. Currently, only one checkpoint per request is supported."
        },
        "contextMap":{
            "type":"array",
            "description":"additional context for rule evaluation.",
            "items":{
                "$ref":"#/components/schemas/KeyValPair"
            }
        }
    }
}

Nested Schema : checkpointList

Type: array

List of checkpoints to be executed. Currently, only one checkpoint per request is supported.

Show Source

• Array of: integer

{
    "type":"array",
    "items":{
        "type":"integer"
    },
    "description":"List of checkpoints to be executed. Currently, only one checkpoint per request is supported."
}

Nested Schema : contextMap

Type: array

additional context for rule evaluation.

Show Source

• Array of: object KeyValPair
  Key-value pair which can be used generically.

{
    "type":"array",
    "description":"additional context for rule evaluation.",
    "items":{
        "$ref":"#/components/schemas/KeyValPair"
    }
}

Nested Schema : KeyValPair

Type: object

Key-value pair which can be used generically.

Show Source

• key(required): string
  Key that can be used to fetch the related value.
• value(required): string
  associated value.

{
    "type":"object",
    "description":"Key-value pair which can be used generically.",
    "required":[
        "key",
        "value"
    ],
    "properties":{
        "key":{
            "type":"string",
            "description":"Key that can be used to fetch the related value."
        },
        "value":{
            "type":"string",
            "description":"associated value."
        }
    }
}

Request Body - application/json ()

Root Schema : schema

Type: object

Process rule request object

Show Source

• checkpointList: array checkpointList
  List of checkpoints to be executed. Currently, only one checkpoint per request is supported.
• contextMap: array contextMap
  additional context for rule evaluation.
• extTransactionId: string
  external transaction Id, used only when transactionId is null
• requestId(required): string
  requestId for the request
• requestTime: string (date-time)
  Date time string in the format rfc3339 sec 5.6. https://tools.ietf.org/html/rfc3339#section-5.6 e.g format 2021-08-13T01:29:29.768Z
• transactionId: number
  User Activity data Identifier created for this session

{
    "type":"object",
    "description":"Process rule request object",
    "required":[
        "requestId"
    ],
    "properties":{
        "requestId":{
            "type":"string",
            "description":"requestId for the request"
        },
        "transactionId":{
            "type":"number",
            "description":"User Activity data Identifier created for this session"
        },
        "extTransactionId":{
            "type":"string",
            "description":"external transaction Id, used only when transactionId is null"
        },
        "requestTime":{
            "$ref":"#/components/schemas/DateTime",
            "description":"time of the request"
        },
        "checkpointList":{
            "type":"array",
            "items":{
                "type":"integer"
            },
            "description":"List of checkpoints to be executed. Currently, only one checkpoint per request is supported."
        },
        "contextMap":{
            "type":"array",
            "description":"additional context for rule evaluation.",
            "items":{
                "$ref":"#/components/schemas/KeyValPair"
            }
        }
    }
}

Nested Schema : checkpointList

Type: array

List of checkpoints to be executed. Currently, only one checkpoint per request is supported.

Show Source

• Array of: integer

{
    "type":"array",
    "items":{
        "type":"integer"
    },
    "description":"List of checkpoints to be executed. Currently, only one checkpoint per request is supported."
}

Nested Schema : contextMap

Type: array

additional context for rule evaluation.

Show Source

• Array of: object KeyValPair
  Key-value pair which can be used generically.

{
    "type":"array",
    "description":"additional context for rule evaluation.",
    "items":{
        "$ref":"#/components/schemas/KeyValPair"
    }
}

Nested Schema : KeyValPair

Type: object

Key-value pair which can be used generically.

Show Source

• key(required): string
  Key that can be used to fetch the related value.
• value(required): string
  associated value.

{
    "type":"object",
    "description":"Key-value pair which can be used generically.",
    "required":[
        "key",
        "value"
    ],
    "properties":{
        "key":{
            "type":"string",
            "description":"Key that can be used to fetch the related value."
        },
        "value":{
            "type":"string",
            "description":"associated value."
        }
    }
}

Back to Top

Response

Supported Media Types

• application/xml
• application/json
• text/plain

200 Response

Rules processed for the authentication context.

Body ()

Root Schema : ProcessRiskResponse

Type: object

Reponse object for processed rules

Show Source

• alertMessageList: array alertMessageList
  List of alerts as per the rules executed
• allActions: array allActions
  List of actions.
• apiRespone: object ProcessRiskApiResponse
  Rule api response for the process rule stating the request status
• deviceId: number
  Returns the associated Device Id.
• result: string
  This is the action to be taken. This action is the after applying the processing rule on the list of actions returned by the rule engine
• resultMap: array resultMap
  Use this to get result of each requested checkpoint. Since there is one checkpoint per rule evaluation request, this field is not used.
• runtimeType: integer
  runtime type of the rule processed.
• score: integer
  Method to get the score after running the rules
• statusResponse: object StatusResponse
  Status information for API call
• transactionLogId: number
  User Activity data Identifier provided in the input.

{
    "type":"object",
    "description":"Reponse object for processed rules",
    "properties":{
        "apiRespone":{
            "$ref":"#/components/schemas/ProcessRiskApiResponse",
            "description":"status of the request"
        },
        "allActions":{
            "type":"array",
            "items":{
                "type":"string"
            },
            "description":"List of actions."
        },
        "result":{
            "type":"string",
            "description":"This is the action to be taken. This action is the after applying the processing rule on the list of actions returned by the rule engine"
        },
        "score":{
            "type":"integer",
            "description":"Method to get the score after running the rules"
        },
        "transactionLogId":{
            "type":"number",
            "description":"User Activity data Identifier provided in the input."
        },
        "resultMap":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/KeyValPair"
            },
            "description":"Use this to get result of each requested checkpoint. Since there is one checkpoint per rule evaluation request, this field is not used."
        },
        "alertMessageList":{
            "type":"array",
            "items":{
                "type":"string"
            },
            "description":"List of alerts as per the rules executed"
        },
        "runtimeType":{
            "type":"integer",
            "description":"runtime type of the rule processed."
        },
        "deviceId":{
            "type":"number",
            "description":"Returns the associated Device Id."
        },
        "statusResponse":{
            "$ref":"#/components/schemas/StatusResponse",
            "description":"response of the rule processing request."
        }
    }
}

Nested Schema : alertMessageList

Type: array

List of alerts as per the rules executed

Show Source

• Array of: string

{
    "type":"array",
    "items":{
        "type":"string"
    },
    "description":"List of alerts as per the rules executed"
}

Nested Schema : allActions

Type: array

List of actions.

Show Source

• Array of: string

{
    "type":"array",
    "items":{
        "type":"string"
    },
    "description":"List of actions."
}

Nested Schema : ProcessRiskApiResponse

Type: object

Rule api response for the process rule stating the request status

Show Source

• responseCode: string
  status code of the request
• responseMessage: string
  response message related to the response code if needed.

{
    "type":"object",
    "description":"Rule api response for the process rule stating the request status",
    "properties":{
        "responseCode":{
            "type":"string",
            "description":"status code of the request"
        },
        "responseMessage":{
            "type":"string",
            "description":"response message related to the response code if needed."
        }
    }
}

Nested Schema : resultMap

Type: array

Use this to get result of each requested checkpoint. Since there is one checkpoint per rule evaluation request, this field is not used.

Show Source

• Array of: object KeyValPair
  Key-value pair which can be used generically.

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/KeyValPair"
    },
    "description":"Use this to get result of each requested checkpoint. Since there is one checkpoint per rule evaluation request, this field is not used."
}

Nested Schema : StatusResponse

Type: object

Status information for API call

Show Source

• responseCode: string
  status code of the request
• responseMessage: string
  response message related to the response code if needed.
• sessionId: string
  session id of the authentcation.
• status: boolean
  authentication update request status
• transactionId: number
  transactionId in case of transaction data.
• userData: object SessionUserData
  user related data

{
    "type":"object",
    "description":"Status information for API call",
    "properties":{
        "responseCode":{
            "type":"string",
            "description":"status code of the request"
        },
        "responseMessage":{
            "type":"string",
            "description":"response message related to the response code if needed."
        },
        "status":{
            "type":"boolean",
            "description":"authentication update request status"
        },
        "sessionId":{
            "type":"string",
            "description":"session id of the authentcation."
        },
        "transactionId":{
            "type":"number",
            "description":"transactionId in case of transaction data."
        },
        "userData":{
            "$ref":"#/components/schemas/SessionUserData",
            "description":"user data used in the session."
        }
    }
}

Nested Schema : KeyValPair

Type: object

Key-value pair which can be used generically.

Show Source

• key(required): string
  Key that can be used to fetch the related value.
• value(required): string
  associated value.

{
    "type":"object",
    "description":"Key-value pair which can be used generically.",
    "required":[
        "key",
        "value"
    ],
    "properties":{
        "key":{
            "type":"string",
            "description":"Key that can be used to fetch the related value."
        },
        "value":{
            "type":"string",
            "description":"associated value."
        }
    }
}

Nested Schema : SessionUserData

Type: object

user related data

Show Source

• groupName(required): string
  group name
• loginName(required): string
  Login name used for authentication
• userId: string
  user identifier.

{
    "type":"object",
    "description":"user related data",
    "required":[
        "loginName",
        "groupName"
    ],
    "properties":{
        "loginName":{
            "type":"string",
            "description":"Login name used for authentication"
        },
        "groupName":{
            "type":"string",
            "description":"group name"
        },
        "userId":{
            "type":"string",
            "description":"user identifier."
        }
    }
}

401 Response

Unauthorized

405 Response

Invalid input

Body ()

Root Schema : ProcessRiskApiResponse

Type: object

Rule api response for the process rule stating the request status

Show Source

• responseCode: string
  status code of the request
• responseMessage: string
  response message related to the response code if needed.

{
    "type":"object",
    "description":"Rule api response for the process rule stating the request status",
    "properties":{
        "responseCode":{
            "type":"string",
            "description":"status code of the request"
        },
        "responseMessage":{
            "type":"string",
            "description":"response message related to the response code if needed."
        }
    }
}

500 Response

Internal server error

503 Response

Service Unavailable

Back to Top