REST API for Risk Service in Oracle Advanced Risk Manager

Update the authentication status of the session

put

https://oaainstall-host/risk-analyzer/session/v1/updatesessionsecurely

Authentication status reflect the status if user login.

Request

There are no request parameters for this operation.

Supported Media Types

application/xml
application/json

Root Schema : schema

Type: object

Session data present in the request.

Show Source

analyzePatterns: boolean

Flag to indicate if autolearnin should be at this point.
authenticationStatus(required): integer

authentication status. One of the config value from auth.status.enum.
clientApplication: string

The client application of the user's session.
clientType(required): integer

The client type of the user's session. (client.type.enum)
clientVersion: string

Version of the client software / browser / device etc.
externalDeviceId: string

Exiernal device id if client wants to populate.
registerDevice: boolean

Attribute is flag when true will result in registering the device for the user.
requestId(required): string

requestId for the request

{
    "type":"object",
    "description":"Session data present in the request.",
    "required":[
        "requestId",
        "authenticationStatus",
        "clientType"
    ],
    "properties":{
        "requestId":{
            "type":"string",
            "description":"requestId for the request"
        },
        "authenticationStatus":{
            "type":"integer",
            "description":"authentication status. One of the config value from auth.status.enum."
        },
        "registerDevice":{
            "type":"boolean",
            "description":"Attribute is flag when true will result in registering the device for the user."
        },
        "clientApplication":{
            "type":"string",
            "description":"The client application of the user's session."
        },
        "clientType":{
            "type":"integer",
            "description":"The client type of the user's session. (client.type.enum)"
        },
        "clientVersion":{
            "type":"string",
            "description":"Version of the client software / browser / device etc."
        },
        "analyzePatterns":{
            "type":"boolean",
            "description":"Flag to indicate if autolearnin should be at this point."
        },
        "externalDeviceId":{
            "type":"string",
            "description":"Exiernal device id if client wants to populate."
        }
    }
}

Root Schema : schema

Type: object

Session data present in the request.

Show Source

analyzePatterns: boolean

Flag to indicate if autolearnin should be at this point.
authenticationStatus(required): integer

authentication status. One of the config value from auth.status.enum.
clientApplication: string

The client application of the user's session.
clientType(required): integer

The client type of the user's session. (client.type.enum)
clientVersion: string

Version of the client software / browser / device etc.
externalDeviceId: string

Exiernal device id if client wants to populate.
registerDevice: boolean

Attribute is flag when true will result in registering the device for the user.
requestId(required): string

requestId for the request

{
    "type":"object",
    "description":"Session data present in the request.",
    "required":[
        "requestId",
        "authenticationStatus",
        "clientType"
    ],
    "properties":{
        "requestId":{
            "type":"string",
            "description":"requestId for the request"
        },
        "authenticationStatus":{
            "type":"integer",
            "description":"authentication status. One of the config value from auth.status.enum."
        },
        "registerDevice":{
            "type":"boolean",
            "description":"Attribute is flag when true will result in registering the device for the user."
        },
        "clientApplication":{
            "type":"string",
            "description":"The client application of the user's session."
        },
        "clientType":{
            "type":"integer",
            "description":"The client type of the user's session. (client.type.enum)"
        },
        "clientVersion":{
            "type":"string",
            "description":"Version of the client software / browser / device etc."
        },
        "analyzePatterns":{
            "type":"boolean",
            "description":"Flag to indicate if autolearnin should be at this point."
        },
        "externalDeviceId":{
            "type":"string",
            "description":"Exiernal device id if client wants to populate."
        }
    }
}

Response

Supported Media Types

application/xml
application/json
text/plain

200 Response

User authentication session status is updated

Root 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 : 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."
        }
    }
}

400 Response

Invalid input

Root 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 : 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

500 Response

Internal server error

503 Response

Service Unavailable

Examples

The following example shows a sample request and response for updating the session status for a user authentication.

cURL Command to Update the Session Status in JSON Format

curl --location --request PUT '<RISK>/risk-analyzer/session/v1/updatesessionsecurely' \
--header 'Content-Type: application/json' \
--header 'Authorization: Basic <Base64Encoded(<username>:<password>)>' \
--data '{
        "requestId":"96eb744b-b84e-4c13-8b78-06b64ad81d94",
        "authenticationStatus": "999",
        "registerDevice": "true",
        "clientApplication": "OAA Update",
        "clientType": "0",
        "clientVersion": "12.2.1.4.2",
        "analyzePatterns": "true"
}'

Sample Response in JSON Format

{
    "responseCode": "0",
    "responseMessage": "",
    "status": true,
    "sessionId": "96eb744b-b84e-4c13-8b78-06b64ad81d94"
}

cURL Command to Update the Session Status in XML Format

curl --location --request PUT '<RISK>/risk-analyzer/session/v1/updatesessionsecurely' \
--header 'Content-Type: application/xml' \
--header 'Accept: application/xml' \
--header 'Authorization: Basic <Base64Encoded(<username>:<password>)>' \
--data '
<?xml version="1.0" encoding="UTF-8" ?>
<SessionData>
	<requestId>96eb744b-b84e-4c13-8b78-06b64ad81d94</requestId>
	<authenticationStatus>999</authenticationStatus>
	<registerDevice>true</registerDevice>
	<clientApplication>OAA Update</clientApplication>
	<clientType>0</clientType>
	<clientVersion>12.2.1.4.2</clientVersion>
	<analyzePatterns>true</analyzePatterns>
</SessionData>
'

Sample Response in XML Format

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<StatusResponse>
	<responseCode>0</responseCode>
	<responseMessage></responseMessage>
	<status>true</status>
	<sessionId>96eb744b-b84e-4c13-8b78-06b64ad81d94</sessionId>
</StatusResponse>