Risk API

Risk APIs in Swagger Format
none
{ "swagger": "2.0", "tags": [ { "name": "Risk", "description": "Use the Risk Admin APIs to manage your risk factors." } ], "paths": { "/{tenantName}/admin/v1/ExceptionUsers": { "get": { "tags": [ "Risk" ], "summary": "Use the ExceptionUsers API as a GET request to retrieve a list of all users that have been granted an exception to all risk factors.", "operationId": "getAllUsingGET", "produces": [ "*/*" ], "parameters": [ { "name": "Authorization", "in": "header", "description": "Bearer Token", "required": true, "type": "string" }, { "name": "filter", "in": "query", "description": "filter", "required": false, "type": "string", "allowEmptyValue": false } ], "responses": { "200": { "description": "Ok", "schema": { "type": "array", "items": { "originalRef": "#/definitions/ExceptionUserDTO", "$ref": "#/definitions/ExceptionUserDTO" } }, "responseSchema": { "type": "array", "items": { "originalRef": "#/definitions/ExceptionUserDTO", "$ref": "#/definitions/ExceptionUserDTO" } } }, "401": { "description": "Unauthorized", "schema": { "originalRef": "#/definitions/APIError", "$ref": "#/definitions/APIError" }, "responseSchema": { "originalRef": "#/definitions/APIError", "$ref": "#/definitions/APIError" } } }, "deprecated": false }, "post": { "tags": [ "Risk" ], "summary": "Use the ExceptionUsers API as a POST request to add a new user to the list of users granted an exception to all risk factors.", "operationId": "createUsingPOST", "consumes": [ "application/json" ], "produces": [ "*/*" ], "parameters": [ { "name": "Authorization", "in": "header", "description": "Bearer Token", "required": true, "type": "string" }, { "in": "body", "name": "req", "description": "Request JSON payload", "required": false, "schema": { "originalRef": "#/definitions/ExceptionUserRequestDTO", "$ref": "#/definitions/ExceptionUserRequestDTO" } } ], "responses": { "201": { "description": "created", "schema": { "originalRef": "#/definitions/ExceptionUserDTO", "$ref": "#/definitions/ExceptionUserDTO" }, "responseSchema": { "originalRef": "#/definitions/ExceptionUserDTO", "$ref": "#/definitions/ExceptionUserDTO" } }, "400": { "description": "Bad Request", "schema": { "originalRef": "#/definitions/APIError", "$ref": "#/definitions/APIError" }, "responseSchema": { "originalRef": "#/definitions/APIError", "$ref": "#/definitions/APIError" } }, "401": { "description": "Unauthorized", "schema": { "originalRef": "#/definitions/APIError", "$ref": "#/definitions/APIError" }, "responseSchema": { "originalRef": "#/definitions/APIError", "$ref": "#/definitions/APIError" } } }, "deprecated": false }, "parameters": [ { "name": "tenantName", "in": "path", "description": "tenantName", "required": true, "type": "string" } ] }, "/{tenantName}/admin/v1/ExceptionUsers/{exceptionUserId}": { "get": { "tags": [ "Risk" ], "summary": "Use the ExceptionUsers/{exceptionUserId} API as a GET request to retrieve information about a specific user that has been granted an exception to all risk factors.", "operationId": "getUsingGET", "produces": [ "*/*" ], "parameters": [ { "name": "Authorization", "in": "header", "description": "Bearer Token", "required": true, "type": "string" }, { "name": "exceptionUserId", "in": "path", "description": "exceptionUserId", "required": true, "type": "string" } ], "responses": { "200": { "description": "Ok", "schema": { "originalRef": "#/definitions/ExceptionUserDTO", "$ref": "#/definitions/ExceptionUserDTO" }, "responseSchema": { "originalRef": "#/definitions/ExceptionUserDTO", "$ref": "#/definitions/ExceptionUserDTO" } }, "401": { "description": "Unauthorized", "schema": { "originalRef": "#/definitions/APIError", "$ref": "#/definitions/APIError" }, "responseSchema": { "originalRef": "#/definitions/APIError", "$ref": "#/definitions/APIError" } }, "404": { "description": "Not Found", "schema": { "originalRef": "#/definitions/APIError", "$ref": "#/definitions/APIError" }, "responseSchema": { "originalRef": "#/definitions/APIError", "$ref": "#/definitions/APIError" } } }, "deprecated": false }, "put": { "tags": [ "Risk" ], "summary": "Use the ExceptionUsers/{exceptionUserId} API as a PUT request to update information about a specific user that has been granted an exception to all risk factor.", "operationId": "updateUsingPUT", "consumes": [ "application/json" ], "produces": [ "*/*" ], "parameters": [ { "name": "Authorization", "in": "header", "description": "Bearer Token", "required": true, "type": "string" }, { "name": "exceptionUserId", "in": "path", "description": "exceptionUserId", "required": true, "type": "string" }, { "in": "body", "name": "req", "description": "req", "required": true, "schema": { "originalRef": "#/definitions/ExceptionUserRequestDTO", "$ref": "#/definitions/ExceptionUserRequestDTO" } } ], "responses": { "200": { "description": "Updated", "schema": { "originalRef": "#/definitions/ExceptionUserDTO", "$ref": "#/definitions/ExceptionUserDTO" }, "responseSchema": { "originalRef": "#/definitions/ExceptionUserDTO", "$ref": "#/definitions/ExceptionUserDTO" } }, "400": { "description": "Bad Request", "schema": { "originalRef": "#/definitions/APIError", "$ref": "#/definitions/APIError" }, "responseSchema": { "originalRef": "#/definitions/APIError", "$ref": "#/definitions/APIError" } }, "401": { "description": "Unauthorized", "schema": { "originalRef": "#/definitions/APIError", "$ref": "#/definitions/APIError" }, "responseSchema": { "originalRef": "#/definitions/APIError", "$ref": "#/definitions/APIError" } } }, "deprecated": false }, "delete": { "tags": [ "Risk" ], "summary": "Use the ExceptionUsers/{exceptionUserId} API as a DELETE request to remove a specific user from the list of those that have been granted an exception to all risk factors.", "operationId": "deleteUsingDELETE", "produces": [ "*/*" ], "parameters": [ { "name": "Authorization", "in": "header", "description": "Bearer Token", "required": true, "type": "string" }, { "name": "exceptionUserId", "in": "path", "description": "exceptionUserId", "required": true, "type": "string" } ], "responses": { "204": { "description": "NO_CONTENT" }, "401": { "description": "Unauthorized", "schema": { "originalRef": "#/definitions/APIError", "$ref": "#/definitions/APIError" }, "responseSchema": { "originalRef": "#/definitions/APIError", "$ref": "#/definitions/APIError" } }, "404": { "description": "Not Found", "schema": { "originalRef": "#/definitions/APIError", "$ref": "#/definitions/APIError" }, "responseSchema": { "originalRef": "#/definitions/APIError", "$ref": "#/definitions/APIError" } } }, "deprecated": false }, "parameters": [ { "name": "tenantName", "in": "path", "description": "tenantName", "required": true, "type": "string" } ] }, "/{tenantName}/admin/v1/NegativeCountries": { "get": { "tags": [ "Risk" ], "summary": "Use the NegativeCountries API as a GET request to retrieve a list of countries in the negative countries risk factor.", "operationId": "getAllUsingGET_2", "produces": [ "*/*" ], "parameters": [ { "name": "Authorization", "in": "header", "description": "Bearer Token", "required": true, "type": "string" }, { "name": "filter", "in": "query", "description": "filter", "required": false, "type": "string", "allowEmptyValue": false } ], "responses": { "200": { "description": "Ok", "schema": { "type": "array", "items": { "originalRef": "#/definitions/NegativeCountryDTO", "$ref": "#/definitions/NegativeCountryDTO" } }, "responseSchema": { "type": "array", "items": { "originalRef": "#/definitions/NegativeCountryDTO", "$ref": "#/definitions/NegativeCountryDTO" } } }, "401": { "description": "Unauthorized", "schema": { "originalRef": "#/definitions/APIError", "$ref": "#/definitions/APIError" }, "responseSchema": { "originalRef": "#/definitions/APIError", "$ref": "#/definitions/APIError" } } }, "deprecated": false }, "post": { "tags": [ "Risk" ], "summary": "Use the NegativeCountries API as a POST request to add a country to the negative countries risk factor.", "operationId": "createUsingPOST_1", "consumes": [ "application/json" ], "produces": [ "*/*" ], "parameters": [ { "name": "Authorization", "in": "header", "description": "Bearer Token", "required": true, "type": "string" }, { "in": "body", "name": "req", "description": "req", "required": true, "schema": { "originalRef": "#/definitions/NegativeCountryRequestDTO", "$ref": "#/definitions/NegativeCountryRequestDTO" } } ], "responses": { "201": { "description": "created", "schema": { "originalRef": "#/definitions/NegativeCountryDTO", "$ref": "#/definitions/NegativeCountryDTO" }, "responseSchema": { "originalRef": "#/definitions/NegativeCountryDTO", "$ref": "#/definitions/NegativeCountryDTO" } }, "400": { "description": "Bad Request", "schema": { "originalRef": "#/definitions/APIError", "$ref": "#/definitions/APIError" }, "responseSchema": { "originalRef": "#/definitions/APIError", "$ref": "#/definitions/APIError" } }, "401": { "description": "Unauthorized", "schema": { "originalRef": "#/definitions/APIError", "$ref": "#/definitions/APIError" }, "responseSchema": { "originalRef": "#/definitions/APIError", "$ref": "#/definitions/APIError" } } }, "deprecated": false }, "parameters": [ { "name": "tenantName", "in": "path", "description": "tenantName", "required": true, "type": "string" } ] }, "/{tenantName}/admin/v1/NegativeCountries/{negativeCountryId}": { "get": { "tags": [ "Risk" ], "summary": "Use the NegativeCountries/{negativeCountryId} API as a GET request to retrieve information about a specific country in the negative countries risk factor.", "operationId": "getUsingGET_1", "produces": [ "*/*" ], "parameters": [ { "name": "Authorization", "in": "header", "description": "Bearer Token", "required": true, "type": "string" }, { "name": "negativeCountryId", "in": "path", "description": "negativeCountryId", "required": true, "type": "string" } ], "responses": { "200": { "description": "Ok", "schema": { "originalRef": "#/definitions/NegativeCountryDTO", "$ref": "#/definitions/NegativeCountryDTO" }, "responseSchema": { "originalRef": "#/definitions/NegativeCountryDTO", "$ref": "#/definitions/NegativeCountryDTO" } }, "401": { "description": "Unauthorized", "schema": { "originalRef": "#/definitions/APIError", "$ref": "#/definitions/APIError" }, "responseSchema": { "originalRef": "#/definitions/APIError", "$ref": "#/definitions/APIError" } }, "404": { "description": "Not Found", "schema": { "originalRef": "#/definitions/APIError", "$ref": "#/definitions/APIError" }, "responseSchema": { "originalRef": "#/definitions/APIError", "$ref": "#/definitions/APIError" } } }, "deprecated": false }, "delete": { "tags": [ "Risk" ], "summary": "Use the NegativeCountries/{negativeCountryId} API as a DELETE request to delete a specific country from the negative countries risk factor.", "operationId": "deleteUsingDELETE_2", "produces": [ "*/*" ], "parameters": [ { "name": "Authorization", "in": "header", "description": "Bearer Token", "required": true, "type": "string" }, { "name": "negativeCountryId", "in": "path", "description": "negativeCountryId", "required": true, "type": "string" } ], "responses": { "204": { "description": "NO_CONTENT" }, "401": { "description": "Unauthorized", "schema": { "originalRef": "#/definitions/APIError", "$ref": "#/definitions/APIError" }, "responseSchema": { "originalRef": "#/definitions/APIError", "$ref": "#/definitions/APIError" } }, "404": { "description": "Not Found", "schema": { "originalRef": "#/definitions/APIError", "$ref": "#/definitions/APIError" }, "responseSchema": { "originalRef": "#/definitions/APIError", "$ref": "#/definitions/APIError" } } }, "deprecated": false }, "parameters": [ { "name": "tenantName", "in": "path", "description": "tenantName", "required": true, "type": "string" } ] }, "/{tenantName}/admin/v1/RiskFactors": { "get": { "tags": [ "Risk" ], "summary": "Use the Risk Factors API to retrieve details about all risk factors configured in your VIP Authentication Hub", "operationId": "getAllUsingGET_3", "produces": [ "*/*" ], "parameters": [ { "name": "Authorization", "in": "header", "description": "Bearer Token", "required": true, "type": "string" }, { "name": "filter", "in": "query", "description": "filter", "required": false, "type": "string", "allowEmptyValue": false } ], "responses": { "200": { "description": "Ok", "schema": { "type": "array", "items": { "originalRef": "#/definitions/RiskFactorDTO", "$ref": "#/definitions/RiskFactorDTO" } }, "responseSchema": { "type": "array", "items": { "originalRef": "#/definitions/RiskFactorDTO", "$ref": "#/definitions/RiskFactorDTO" } } }, "401": { "description": "Unauthorized", "schema": { "originalRef": "#/definitions/APIError", "$ref": "#/definitions/APIError" }, "responseSchema": { "originalRef": "#/definitions/APIError", "$ref": "#/definitions/APIError" } } }, "deprecated": false }, "parameters": [ { "name": "tenantName", "in": "path", "description": "tenantName", "required": true, "type": "string" } ] }, "/{tenantName}/admin/v1/RiskFactors/{riskFactorId}": { "get": { "tags": [ "Risk" ], "summary": "Use the RiskFactors/{riskFactorId} API as a GET request to retrieve information about a specific risk factor in your VIP Authentication Hub.", "operationId": "getUsingGET_2", "produces": [ "*/*" ], "parameters": [ { "name": "Authorization", "in": "header", "description": "Bearer Token", "required": true, "type": "string" }, { "name": "riskFactorId", "in": "path", "description": "riskFactorId", "required": true, "type": "string" } ], "responses": { "200": { "description": "Ok", "schema": { "originalRef": "#/definitions/RiskFactorDTO", "$ref": "#/definitions/RiskFactorDTO" }, "responseSchema": { "originalRef": "#/definitions/RiskFactorDTO", "$ref": "#/definitions/RiskFactorDTO" } }, "401": { "description": "Unauthorized", "schema": { "originalRef": "#/definitions/APIError", "$ref": "#/definitions/APIError" }, "responseSchema": { "originalRef": "#/definitions/APIError", "$ref": "#/definitions/APIError" } }, "404": { "description": "Not Found", "schema": { "originalRef": "#/definitions/APIError", "$ref": "#/definitions/APIError" }, "responseSchema": { "originalRef": "#/definitions/APIError", "$ref": "#/definitions/APIError" } } }, "deprecated": false }, "put": { "tags": [ "Risk" ], "summary": "Use the RiskFactors/{riskFactorId} API as a PUT request to update information about a specific risk factor in your VIP Authentication Hub.", "operationId": "updateUsingPUT_2", "consumes": [ "application/json" ], "produces": [ "*/*" ], "parameters": [ { "name": "Authorization", "in": "header", "description": "Bearer Token", "required": true, "type": "string" }, { "in": "body", "name": "requestDTO", "description": "requestDTO", "required": true, "schema": { "originalRef": "#/definitions/RiskFactorRequestDTO", "$ref": "#/definitions/RiskFactorRequestDTO" } }, { "name": "riskFactorId", "in": "path", "description": "riskFactorId", "required": true, "type": "string" } ], "responses": { "200": { "description": "Updated", "schema": { "originalRef": "#/definitions/RiskFactorDTO", "$ref": "#/definitions/RiskFactorDTO" }, "responseSchema": { "originalRef": "#/definitions/RiskFactorDTO", "$ref": "#/definitions/RiskFactorDTO" } }, "400": { "description": "Bad Request", "schema": { "originalRef": "#/definitions/APIError", "$ref": "#/definitions/APIError" }, "responseSchema": { "originalRef": "#/definitions/APIError", "$ref": "#/definitions/APIError" } }, "401": { "description": "Unauthorized", "schema": { "originalRef": "#/definitions/APIError", "$ref": "#/definitions/APIError" }, "responseSchema": { "originalRef": "#/definitions/APIError", "$ref": "#/definitions/APIError" } } }, "deprecated": false }, "parameters": [ { "name": "tenantName", "in": "path", "description": "tenantName", "required": true, "type": "string" } ] }, "/{tenantName}/admin/v1/UntrustedIps": { "get": { "tags": [ "Risk" ], "summary": "Use the UntrustedIps API as a GET request to retrieve a list of all untrusted IP addresses and IP address ranges in your VIP Authentication Hub.", "operationId": "getAllUsingGET_5", "produces": [ "*/*" ], "parameters": [ { "name": "Authorization", "in": "header", "description": "Bearer Token", "required": true, "type": "string" }, { "name": "filter", "in": "query", "description": "filter", "required": false, "type": "string", "allowEmptyValue": false } ], "responses": { "200": { "description": "Ok", "schema": { "type": "array", "items": { "originalRef": "#/definitions/UnTrustedIPDTO", "$ref": "#/definitions/UnTrustedIPDTO" } }, "responseSchema": { "type": "array", "items": { "originalRef": "#/definitions/UnTrustedIPDTO", "$ref": "#/definitions/UnTrustedIPDTO" } } }, "401": { "description": "Unauthorized", "schema": { "originalRef": "#/definitions/APIError", "$ref": "#/definitions/APIError" }, "responseSchema": { "originalRef": "#/definitions/APIError", "$ref": "#/definitions/APIError" } } }, "deprecated": false }, "post": { "tags": [ "Risk" ], "summary": "Use the UntrustedIps API as a POST request to add an IP address or IP address range to the list of all untrusted IP addresses and IP address ranges in your VIP Authentication Hub.", "operationId": "createUsingPOST_3", "consumes": [ "application/json" ], "produces": [ "*/*" ], "parameters": [ { "name": "Authorization", "in": "header", "description": "Bearer Token", "required": true, "type": "string" }, { "in": "body", "name": "req", "description": "req", "required": true, "schema": { "originalRef": "#/definitions/UnTrustedIPRequestDTO", "$ref": "#/definitions/UnTrustedIPRequestDTO" } } ], "responses": { "201": { "description": "created", "schema": { "originalRef": "#/definitions/UnTrustedIPDTO", "$ref": "#/definitions/UnTrustedIPDTO" }, "responseSchema": { "originalRef": "#/definitions/UnTrustedIPDTO", "$ref": "#/definitions/UnTrustedIPDTO" } }, "400": { "description": "Bad Request", "schema": { "originalRef": "#/definitions/APIError", "$ref": "#/definitions/APIError" }, "responseSchema": { "originalRef": "#/definitions/APIError", "$ref": "#/definitions/APIError" } }, "401": { "description": "Unauthorized", "schema": { "originalRef": "#/definitions/APIError", "$ref": "#/definitions/APIError" }, "responseSchema": { "originalRef": "#/definitions/APIError", "$ref": "#/definitions/APIError" } } }, "deprecated": false }, "parameters": [ { "name": "tenantName", "in": "path", "description": "tenantName", "required": true, "type": "string" } ] }, "/{tenantName}/admin/v1/UntrustedIps/{untrustedIpId}": { "get": { "tags": [ "Risk" ], "summary": "Use the UntrustedIps/{untrustedIpId} API as a GET request to retrieve information about a specific untrusted IP address or IP address range in your VIP Authentication Hub.", "operationId": "getUsingGET_4", "produces": [ "*/*" ], "parameters": [ { "name": "Authorization", "in": "header", "description": "Bearer Token", "required": true, "type": "string" }, { "name": "untrustedIpId", "in": "path", "description": "untrustedIpId", "required": true, "type": "string" } ], "responses": { "200": { "description": "Ok", "schema": { "originalRef": "#/definitions/UnTrustedIPDTO", "$ref": "#/definitions/UnTrustedIPDTO" }, "responseSchema": { "originalRef": "#/definitions/UnTrustedIPDTO", "$ref": "#/definitions/UnTrustedIPDTO" } }, "401": { "description": "Unauthorized", "schema": { "originalRef": "#/definitions/APIError", "$ref": "#/definitions/APIError" }, "responseSchema": { "originalRef": "#/definitions/APIError", "$ref": "#/definitions/APIError" } }, "404": { "description": "Not Found", "schema": { "originalRef": "#/definitions/APIError", "$ref": "#/definitions/APIError" }, "responseSchema": { "originalRef": "#/definitions/APIError", "$ref": "#/definitions/APIError" } } }, "deprecated": false }, "put": { "tags": [ "Risk" ], "summary": "Use the UntrustedIps/{untrustedIpId} API as a PUT request to update information about a specific untrusted IP address or IP address range in your VIP Authentication Hub.", "operationId": "updateUsingPUT_5", "consumes": [ "application/json" ], "produces": [ "*/*" ], "parameters": [ { "name": "Authorization", "in": "header", "description": "Bearer Token", "required": true, "type": "string" }, { "in": "body", "name": "req", "description": "req", "required": true, "schema": { "originalRef": "#/definitions/UnTrustedIPRequestDTO", "$ref": "#/definitions/UnTrustedIPRequestDTO" } }, { "name": "untrustedIpId", "in": "path", "description": "untrustedIpId", "required": true, "type": "string" } ], "responses": { "200": { "description": "created", "schema": { "originalRef": "#/definitions/UnTrustedIPDTO", "$ref": "#/definitions/UnTrustedIPDTO" }, "responseSchema": { "originalRef": "#/definitions/UnTrustedIPDTO", "$ref": "#/definitions/UnTrustedIPDTO" } }, "400": { "description": "Bad Request", "schema": { "originalRef": "#/definitions/APIError", "$ref": "#/definitions/APIError" }, "responseSchema": { "originalRef": "#/definitions/APIError", "$ref": "#/definitions/APIError" } }, "401": { "description": "Unauthorized", "schema": { "originalRef": "#/definitions/APIError", "$ref": "#/definitions/APIError" }, "responseSchema": { "originalRef": "#/definitions/APIError", "$ref": "#/definitions/APIError" } } }, "deprecated": false }, "delete": { "tags": [ "Risk" ], "summary": "Use the UntrustedIps/{untrustedIpId} API as a DELETE request to delete a specific untrusted IP address or IP address range from your VIP Authentication Hub.", "operationId": "deleteUsingDELETE_5", "produces": [ "*/*" ], "parameters": [ { "name": "Authorization", "in": "header", "description": "Bearer Token", "required": true, "type": "string" }, { "name": "untrustedIpId", "in": "path", "description": "untrustedIpId", "required": true, "type": "string" } ], "responses": { "204": { "description": "NO_CONTENT" }, "401": { "description": "Unauthorized", "schema": { "originalRef": "#/definitions/APIError", "$ref": "#/definitions/APIError" }, "responseSchema": { "originalRef": "#/definitions/APIError", "$ref": "#/definitions/APIError" } }, "404": { "description": "Not Found", "schema": { "originalRef": "#/definitions/APIError", "$ref": "#/definitions/APIError" }, "responseSchema": { "originalRef": "#/definitions/APIError", "$ref": "#/definitions/APIError" } } }, "deprecated": false }, "parameters": [ { "name": "tenantName", "in": "path", "description": "tenantName", "required": true, "type": "string" } ] } }, "definitions": { "APIError": { "type": "object", "properties": { "errorCode": { "type": "string" }, "errorMessage": { "type": "string" } }, "title": "APIError" }, "ExceptionUserDTO": { "type": "object", "required": [ "endDate", "startDate", "userId" ], "properties": { "createdBy": { "description": "Represents details about the created principal", "originalRef": "#/definitions/PrincipalDTO", "$ref": "#/definitions/PrincipalDTO" }, "createdDatetime": { "type": "string", "example": "yyyy-MM-dd HH:mm a z" }, "endDate": { "type": "string", "example": "yyyy-MM-dd HH:mm a z", "description": "Represents the date when the user is no longer treated as an exception" }, "reason": { "type": "string", "example": "User is travelling to a Negative Country", "description": "Valid reason" }, "riskExceptionUserId": { "type": "string", "example": "a62ef2b5-4ecf-400a-ad5e-af55b47b527d", "description": "unique identifier" }, "startDate": { "type": "string", "example": "yyyy-MM-dd HH:mm a z", "description": "Represents the date when the user begins to be treated as an exception" }, "tenantId": { "type": "string", "example": "a62ef2b5-4ecf-400a-ad5e-af55b47b527d", "description": "tenant identifier" }, "tenantName": { "type": "string", "example": "default", "description": "tenant name" }, "updatedBy": { "description": "Represents details about the updated principal", "originalRef": "#/definitions/PrincipalDTO", "$ref": "#/definitions/PrincipalDTO" }, "updatedDatetime": { "type": "string", "example": "yyyy-MM-dd HH:mm a z" }, "userId": { "type": "string", "example": "a62ef2b5-4ecf-400a-ad5e-af55b47b527d", "description": "User identifier" }, "userName": { "type": "string", "example": "Mal Bail", "description": "User Name" } }, "title": "ExceptionUserDTO" }, "ExceptionUserRequestDTO": { "type": "object", "required": [ "endDate", "startDate", "userId" ], "properties": { "endDate": { "type": "string", "example": "yyyy-MM-dd HH:mm a z", "description": "Represents the date when the user is no longer treated as an exception" }, "reason": { "type": "string", "example": "User is travelling to a Negative Country", "description": "Valid reason" }, "startDate": { "type": "string", "example": "yyyy-MM-dd HH:mm a z", "description": "Represents the date when the user begins to be treated as an exception" }, "userId": { "type": "string", "example": "a62ef2b5-4ecf-400a-ad5e-af55b47b527d", "description": "User identifier" } }, "title": "ExceptionUserRequestDTO" }, "NegativeCountryDTO": { "type": "object", "required": [ "isoCode" ], "properties": { "createdBy": { "description": "Represents details about the created principal", "originalRef": "#/definitions/PrincipalDTO", "$ref": "#/definitions/PrincipalDTO" }, "createdDatetime": { "type": "string", "example": "2019-10-18 04:49 AM UTC", "description": "Represents created date time" }, "isoCode": { "type": "string", "example": "US for United States", "description": "Represents ISO code of the country" }, "negativeCountryId": { "type": "string", "example": "a62ef2b5-4ecf-400a-ad5e-af55b47b527d", "description": "unique identifier" }, "tenantId": { "type": "string", "example": "a62ef2b5-4ecf-400a-ad5e-af55b47b527d", "description": "Tenant identifier" }, "tenantName": { "type": "string", "example": "default", "description": "Repesents Tenant Name" }, "updatedBy": { "description": "Represents details about the updated principal", "originalRef": "#/definitions/PrincipalDTO", "$ref": "#/definitions/PrincipalDTO" }, "updatedDatetime": { "type": "string", "format": "date-time", "example": "2019-10-18 04:49 AM UTC", "description": "Represents updated date time" } }, "title": "NegativeCountryDTO" }, "NegativeCountryRequestDTO": { "type": "object", "required": [ "isoCode" ], "properties": { "isoCode": { "type": "string", "example": "US for United States", "description": "Represents ISO code of the country" } }, "title": "NegativeCountryRequestDTO" }, "RiskFactorDTO": { "type": "object", "required": [ "enabled", "priority", "riskScore" ], "properties": { "enabled": { "type": "boolean", "example": true, "description": "Represents whether to execute Risk Factor or not" }, "priority": { "type": "integer", "format": "int32", "example": 1, "description": "Represents execution priority of the Risk Factor" }, "riskFactorId": { "type": "string", "example": "5", "description": "unique identifier" }, "riskFactorName": { "type": "string", "example": "DEVICE_MFP_MISMATCH", "description": "Represents unique predefined Risk Factor name" }, "riskScore": { "type": "integer", "format": "int32", "example": 65, "description": "Represents the risk score (from 1 to 100)" }, "settings": { "type": "array", "example": [ { "key": "signatureMatchThreshold", "value": "10" } ], "description": "Represents the settings for the factor", "items": { "originalRef": "#/definitions/RiskFactorSettings", "$ref": "#/definitions/RiskFactorSettings" } }, "tenantId": { "type": "string", "example": "a62ef2b5-4ecf-400a-ad5e-af55b47b527d", "description": "unique tenant identifier" }, "tenantName": { "type": "string", "example": "default", "description": "Represents the name Tenant" }, "updatedBy": { "description": "Represents details about the updated principal", "originalRef": "#/definitions/PrincipalDTO", "$ref": "#/definitions/PrincipalDTO" }, "updatedDateTime": { "type": "string", "example": "2019-10-18 04:49 AM UTC", "description": "Represents updated date time" } }, "title": "RiskFactorDTO" }, "RiskFactorRequestDTO": { "type": "object", "required": [ "enabled", "priority", "riskScore" ], "properties": { "enabled": { "type": "boolean", "example": true, "description": "Represents whether to execute Risk Factor or not" }, "priority": { "type": "integer", "format": "int32", "example": 1, "description": "Represents execution priority of the Risk Factor" }, "riskFactorId": { "type": "string", "example": "5", "description": "unique identifier" }, "riskFactorName": { "type": "string", "example": "DEVICE_MFP_MISMATCH", "description": "Represents unique predefined Risk Factor name" }, "riskScore": { "type": "integer", "format": "int32", "example": 65, "description": "Represents the risk score (from 1 to 100)" }, "settings": { "type": "array", "example": [ { "key": "signatureMatchThreshold", "value": "10" } ], "description": "Represents the settings for the factor", "items": { "originalRef": "#/definitions/RiskFactorSettings", "$ref": "#/definitions/RiskFactorSettings" } } }, "title": "RiskFactorRequestDTO" }, "RiskFactorSettings": { "type": "object", "properties": { "key": { "type": "string", "example": "signatureMatchThreshold", "description": "Represents name of the property" }, "value": { "type": "string", "example": "100", "description": "Represents value of the property" } }, "title": "RiskFactorSettings" }, "PrincipalDTO": { "type": "object", "properties": { "principalId": { "type": "string", "example": "a62ef2b5-4ecf-400a-ad5e-af55b47b527d", "description": "Represents the unique principal identifier" }, "principalName": { "type": "string", "example": "John", "description": "Represents the principal name at the time of creation/update operation" }, "principalType": { "type": "string", "example": "USER", "description": "Represents the principal type (USER/CLIENT)" } }, "title": "PrincipalDTO" } } }