Jump to

• Request
• Response

Deprecated - Update the authentication status of the session

put

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

Deprecated: Please use updatesessionsecurely API. This API updates authentication status of the user's session

Request

Path Parameters

• requestId(required): string

Supported Media Types

• application/xml
• application/json

Request Body - application/xml ()

Root Schema : schema

Type: object

Session data present in the request.

Show Source

• analyzePatterns: boolean
  Flag to indicate if pattern analysis should be done for this session. Set this flag to true, if pattern based rules are used.
• authenticationStatus(required): integer
  One of the config values from auth.status.enum. To check the possible values of the auth.status.enum, use the config property REST API operation GET with URL <PolicyURL>/policy/config/property/v1?propertyName=auth.status.enum. It is recommended to use a value corresponding to pending status when creating the session.
• clientApplication: string
  The client application of the user's session. This is a customer defined value, typically of the application name that is using or integrating with this API.
• clientType(required): integer
  The client type of the user's session. One of the config values from client.type.enum. To check the possible values of the client.type.enum, use the config property REST API operation GET with URL <PolicyURL>/policy/config/property/v1?propertyName=client.type.enum
• clientVersion: string
  The version of the client application of the user's session. This is a customer defined value, typically of the version of the application that is using or integrating with this API.
• externalDeviceId: string
  External device id if the client wants to populate. This is a customer defined value, and can be used to identify, or indicate, a device name or some external Id, that this session may be coming from. A typical example can be a name or id of the terminal where the session is originating
• 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":"One of the config values from auth.status.enum. To check the possible values of the auth.status.enum, use the config property REST API operation GET with URL <PolicyURL>/policy/config/property/v1?propertyName=auth.status.enum. It is recommended to use a value corresponding to pending status when creating the session."
        },
        "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. This is a customer defined\nvalue, typically of the application name that is  using or integrating with\nthis API."
        },
        "clientType":{
            "type":"integer",
            "description":"The client type of the user's session.\nOne of the config values from client.type.enum.\nTo check the possible values of the client.type.enum, use the config property\nREST API  operation GET  with URL\n<PolicyURL>/policy/config/property/v1?propertyName=client.type.enum"
        },
        "clientVersion":{
            "type":"string",
            "description":"The version of the client application of the user's session. This is a\ncustomer defined value, typically of the version of the application that is\nusing or integrating with this API."
        },
        "analyzePatterns":{
            "type":"boolean",
            "description":"Flag to indicate if pattern analysis should be done for this session.\nSet this flag to true, if pattern based rules are used."
        },
        "externalDeviceId":{
            "type":"string",
            "description":"External device id if the client wants to populate. This is a customer defined value, and can be used to identify, or indicate, a device name or some external Id, that this session may be coming from. A typical example can be a name or id of the terminal where the session is originating"
        }
    }
}

Request Body - application/json ()

Root Schema : schema

Type: object

Session data present in the request.

Show Source

• analyzePatterns: boolean
  Flag to indicate if pattern analysis should be done for this session. Set this flag to true, if pattern based rules are used.
• authenticationStatus(required): integer
  One of the config values from auth.status.enum. To check the possible values of the auth.status.enum, use the config property REST API operation GET with URL <PolicyURL>/policy/config/property/v1?propertyName=auth.status.enum. It is recommended to use a value corresponding to pending status when creating the session.
• clientApplication: string
  The client application of the user's session. This is a customer defined value, typically of the application name that is using or integrating with this API.
• clientType(required): integer
  The client type of the user's session. One of the config values from client.type.enum. To check the possible values of the client.type.enum, use the config property REST API operation GET with URL <PolicyURL>/policy/config/property/v1?propertyName=client.type.enum
• clientVersion: string
  The version of the client application of the user's session. This is a customer defined value, typically of the version of the application that is using or integrating with this API.
• externalDeviceId: string
  External device id if the client wants to populate. This is a customer defined value, and can be used to identify, or indicate, a device name or some external Id, that this session may be coming from. A typical example can be a name or id of the terminal where the session is originating
• 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":"One of the config values from auth.status.enum. To check the possible values of the auth.status.enum, use the config property REST API operation GET with URL <PolicyURL>/policy/config/property/v1?propertyName=auth.status.enum. It is recommended to use a value corresponding to pending status when creating the session."
        },
        "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. This is a customer defined\nvalue, typically of the application name that is  using or integrating with\nthis API."
        },
        "clientType":{
            "type":"integer",
            "description":"The client type of the user's session.\nOne of the config values from client.type.enum.\nTo check the possible values of the client.type.enum, use the config property\nREST API  operation GET  with URL\n<PolicyURL>/policy/config/property/v1?propertyName=client.type.enum"
        },
        "clientVersion":{
            "type":"string",
            "description":"The version of the client application of the user's session. This is a\ncustomer defined value, typically of the version of the application that is\nusing or integrating with this API."
        },
        "analyzePatterns":{
            "type":"boolean",
            "description":"Flag to indicate if pattern analysis should be done for this session.\nSet this flag to true, if pattern based rules are used."
        },
        "externalDeviceId":{
            "type":"string",
            "description":"External device id if the client wants to populate. This is a customer defined value, and can be used to identify, or indicate, a device name or some external Id, that this session may be coming from. A typical example can be a name or id of the terminal where the session is originating"
        }
    }
}

Back to Top

Response

Supported Media Types

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

200 Response

User authentication session status is stored.

Body ()

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

405 Response

Invalid input

Body ()

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

500 Response

Internal server error

503 Response

Service Unavailable

Back to Top