Jump to

• Request
• Response

Enable Clients to Request Mitigation of User's Risk Score

post

/admin/v1/sdk/adaptive/MitigateRisks

Request

Supported Media Types

• application/json

Header Parameters

• Authorization: string
  Provide a valid Admin Access Token

Body ()

Root Schema : MitigateRisks

Type: object

Use this schema for providing values to request mitigation of user's risk score.

Show Source

• data: array data
  This attribute is a key-value pair. For now the adaptive security expects device-fingerprint and client-ip in the request.
  
• event: string
  This is a multivalued attribute with the name of event that will contribute to risk score decay. Supported values for this attribute are:
  

  • SSO_THREAT_MITIGATION_SUCCESS
  • ADMIN_ME_PASSWORD_CHANGE_SUCCESS

  
  
• userName: string
  This attribute helps to uniquely identify a user in IDCS.
  

{
    "type":"object",
    "description":"Use this schema for providing values to request mitigation of user's risk score.",
    "required":[
        "userName",
        "data",
        "event"
    ],
    "properties":{
        "userName":{
            "type":"string",
            "description":"This attribute helps to uniquely identify a user in IDCS.<br>"
        },
        "data":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/Data"
            },
            "description":"This attribute is a key-value pair. For now the adaptive security expects device-fingerprint and client-ip in the request.<br>"
        },
        "event":{
            "type":"string",
            "description":"This is a multivalued attribute with the name of event that will contribute to risk score decay. Supported values for this attribute are:<br/><ul><li>SSO_THREAT_MITIGATION_SUCCESS</li><li>ADMIN_ME_PASSWORD_CHANGE_SUCCESS</li></ul><br>"
        }
    }
}

Nested Schema : data

Type: array

This attribute is a key-value pair. For now the adaptive security expects device-fingerprint and client-ip in the request.

Show Source

• Array of: object Data
  Use this schema to provide values for the object named data.

{
    "type":"array",
    "items":{
        "$ref":"#/definitions/Data"
    },
    "description":"This attribute is a key-value pair. For now the adaptive security expects device-fingerprint and client-ip in the request.<br>"
}

Nested Schema : Data

Type: object

Use this schema to provide values for the object named data.

Show Source

• name: string
  This attribute denotes the key of the key-value pair. Supported values for this attribute are:

  • device
  • client-ip

  
  .
  
• value: string
  This attribute denotes the value of the key-value pair. Supported values for this attribute are:

  • device's fingerprint
  • client's IP address

  
  .
  

{
    "type":"object",
    "description":"Use this schema to provide values for the object named data.",
    "required":[
        "name",
        "value"
    ],
    "properties":{
        "name":{
            "type":"string",
            "description":"This attribute denotes the key of the key-value pair. Supported values for this attribute are:<ul><li>device</li><li>client-ip</li></ul><br>.<br>"
        },
        "value":{
            "type":"string",
            "description":"This attribute denotes the value of the key-value pair. Supported values for this attribute are:<ul><li>device's fingerprint</li><li>client's IP address</li></ul><br>.<br>"
        }
    }
}

Back to Top

Response

Supported Media Types

• application/json

200 Response

Valid POST response

400 Response

Bad request

401 Response

Unauthorized

422 Response

Unprocessable Entity

500 Response

Internal Server error

Back to Top