REST API for Risk Service in Oracle Advanced Risk Manager

Fetch the details of existing session

put

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

Session details are fetched for the given request id.

Request

There are no request parameters for this operation.

Supported Media Types

application/xml
application/json

Root Schema : schema

Type: object

RequestId present in the request body.

Show Source

requestId(required): string

requestId for the request

{
    "type":"object",
    "description":"RequestId present in the request body.",
    "required":[
        "requestId"
    ],
    "properties":{
        "requestId":{
            "type":"string",
            "description":"requestId for the request"
        }
    }
}

Root Schema : schema

Type: object

RequestId present in the request body.

Show Source

requestId(required): string

requestId for the request

{
    "type":"object",
    "description":"RequestId present in the request body.",
    "required":[
        "requestId"
    ],
    "properties":{
        "requestId":{
            "type":"string",
            "description":"requestId for the request"
        }
    }
}

Response

Supported Media Types

application/xml
application/json
text/plain

200 Response

Retrieve user session data

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 retrieving session details for a specific request ID.

cURL Command to Fetch the Session Details in JSON Format

curl --location --request PUT '<RISK>/risk-analyzer/session/v1/fetchsessionsecurely' \
--header 'Content-Type: application/json' \
--header 'Authorization: Basic <Base64Encoded(<username>:<password>)>' \
--data '{
    "requestId":"c3b0af07-942a-42da-b1f7-3edb52c07dd8"
}'

Sample Response in JSON Format

{
    "status": true,
    "sessionId": "c3b0af07-942a-42da-b1f7-3edb52c07dd8",
    "userData": {
        "loginName": "user1",
        "groupName": "financeapp",
        "userId": "22a29071-16f2-4b69-a94c-73be672e34eb"
    }
}

cURL Command to Fetch the Session Details in XML Format

curl --location --request PUT '<RISK>/risk-analyzer/session/v1/fetchsessionsecurely' \
--header 'Content-Type: application/xml' \
--header 'Accept: application/xml' \
--header 'Authorization: Basic <Base64Encoded(<username>:<password>)>' \
--data '
<?xml version="1.0" encoding="UTF-8" ?>
<RequestData>
	<requestId>c3b0af07-942a-42da-b1f7-3edb52c07dd8</requestId>
</RequestData>'

Sample Response in XML Format

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<StatusResponse>
    <status>true</status>
    <sessionId>c3b0af07-942a-42da-b1f7-3edb52c07dd8</sessionId>
    <userData>
        <loginName>user1</loginName>
        <groupName>financeapp</groupName>
        <userId>22a29071-16f2-4b69-a94c-73be672e34eb</userId>
    </userData>
</StatusResponse>