Get user risk-based authentication settings

GET 
/api/web/v1/users/:userid/userrbasettings

Get the user risk-based authentication settings for the specified user. Caller requires the USERRBASETTINGS:VIEW permission.

Request

Path Parameters

userid stringrequired

The UUID of the user whose RBA settings will be retrieved.

Responses

200

Successful

application/json

Schema

Schema

locationHistoryIpCheckRequired boolean

A flag indicating if the IP address is considered when checking to see if two locations are the same.

maximumLocationHistory int32

The maximum number of user locations stored in location history.

velocityCheckRequired boolean

A flag indicating if a velocity check is performed when checking the current location against location history.

Example (from schema)

{
  "locationHistoryIpCheckRequired": true,
  "maximumLocationHistory": 0,
  "velocityCheckRequired": true
}

400

Bad Request

application/json

Schema

Schema

errorCode string

Error Codes specific to cause of failure.

errorMessage string

Additional Error Message describing the error.

parameters object[]

Optional additional error information.

Example (from schema)

{
  "errorCode": "invalid_user_response",
  "errorMessage": "Application id cannot be null",
  "parameters": [
    {}
  ]
}

401

Access denied

application/json

Schema

Schema

errorCode string

Error Codes specific to cause of failure.

errorMessage string

Additional Error Message describing the error.

parameters object[]

Optional additional error information.

Example (from schema)

{
  "errorCode": "invalid_user_response",
  "errorMessage": "Application id cannot be null",
  "parameters": [
    {}
  ]
}

403

Forbidden

application/json

Schema

Schema

errorCode string

Error Codes specific to cause of failure.

errorMessage string

Additional Error Message describing the error.

parameters object[]

Optional additional error information.

Example (from schema)

{
  "errorCode": "invalid_user_response",
  "errorMessage": "Application id cannot be null",
  "parameters": [
    {}
  ]
}

404

Not Found

application/json

Schema

Schema

errorCode string

Error Codes specific to cause of failure.

errorMessage string

Additional Error Message describing the error.

parameters object[]

Optional additional error information.

Example (from schema)

{
  "errorCode": "invalid_user_response",
  "errorMessage": "Application id cannot be null",
  "parameters": [
    {}
  ]
}

409

Conflict

application/json

Schema

Schema

errorCode string

Error Codes specific to cause of failure.

errorMessage string

Additional Error Message describing the error.

parameters object[]

Optional additional error information.

Example (from schema)

{
  "errorCode": "invalid_user_response",
  "errorMessage": "Application id cannot be null",
  "parameters": [
    {}
  ]
}

Loading...