UserRbaSettingsApi
| Method | HTTP request | Description |
|---|---|---|
| deleteUserLocationsUsingDELETE | DELETE /api/web/v1/users/{userid}/userlocations | Delete user location history |
| getUserRbaSettingsUsingGET | GET /api/web/v1/users/{userid}/userrbasettings | Get user risk-based authentication settings |
| ipLocationFromIpAddressUsingPOST | POST /api/web/v1/iplocations | Create IP location |
| listUserExpectedLocationsUsingGET | GET /api/web/v1/users/{userid}/expectedlocations | List expected locations for a user |
| listUserLocationsUsingGET | GET /api/web/v1/users/{userid}/userlocations | Get user location history |
| setUserExpectedLocationsUsingPUT | PUT /api/web/v1/users/{userid}/expectedlocations | Set expected locations for a user |
| updateUserRbaSettingsUsingPUT | PUT /api/web/v1/users/{userid}/userrbasettings | Update user risk-based authentication settings |
deleteUserLocationsUsingDELETE
deleteUserLocationsUsingDELETE(userid, requestBody)
Delete user location history
Delete one or more entries from a user's location history. Caller requires the USERRBASETTINGS:REMOVE permission.
Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| userid | String | The UUID of the user whose location history is to be updated. | |
| requestBody | List<String> |
Return type
null (empty response body)
Authorization
HTTP request headers
- Content-Type: application/json
- Accept: application/json
HTTP response details
| Status code | Description | Response headers |
|---|---|---|
| 200 | Successful | - |
| 400 | Bad Request | - |
| 401 | Access denied | - |
| 403 | Forbidden | - |
| 404 | Not Found | - |
| 409 | Conflict | - |
getUserRbaSettingsUsingGET
UserRbaSettings getUserRbaSettingsUsingGET(userid)
Get user risk-based authentication settings
Get the user risk-based authentication settings for the specified user. Caller requires the USERRBASETTINGS:VIEW permission.
Example
Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| userid | String | The UUID of the user whose RBA settings will be retrieved. |
Return type
Authorization
HTTP request headers
- Content-Type: Not defined
- Accept: application/json
HTTP response details
| Status code | Description | Response headers |
|---|---|---|
| 200 | Successful | - |
| 400 | Bad Request | - |
| 401 | Access denied | - |
| 403 | Forbidden | - |
| 404 | Not Found | - |
| 409 | Conflict | - |
ipLocationFromIpAddressUsingPOST
IpLocation ipLocationFromIpAddressUsingPOST(ipLocation)
Create IP location
Gets IP location information for an IP address. The IP location can be used to create an ExpectedLocation. Caller requires the USERRBASETTINGS:ADD permission.
Example
Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| ipLocation | IpLocation |
Return type
Authorization
HTTP request headers
- Content-Type: application/json
- Accept: application/json
HTTP response details
| Status code | Description | Response headers |
|---|---|---|
| 200 | Successful | - |
| 400 | Bad Request | - |
| 401 | Access denied | - |
| 403 | Forbidden | - |
| 404 | Not Found | - |
| 409 | Conflict | - |
listUserExpectedLocationsUsingGET
UserExpectedLocations listUserExpectedLocationsUsingGET(userid)
List expected locations for a user
Lists the expected locations for the specified user. Caller requires the USERRBASETTINGS:VIEW permission.
Example
Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| userid | String | The UUID of the user whose expected locations will be returned. |
Return type
Authorization
HTTP request headers
- Content-Type: Not defined
- Accept: application/json
HTTP response details
| Status code | Description | Response headers |
|---|---|---|
| 200 | Successful | - |
| 400 | Bad Request | - |
| 401 | Access denied | - |
| 403 | Forbidden | - |
| 404 | Not Found | - |
| 409 | Conflict | - |
listUserLocationsUsingGET
List<UserLocation> listUserLocationsUsingGET(userid)
Get user location history
Get the location history of the specified user. Caller requires the USERRBASETTINGS:VIEW permission.
Example
Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| userid | String | The UUID of the user whose location history is to be retrieved. |
Return type
Authorization
HTTP request headers
- Content-Type: Not defined
- Accept: application/json
HTTP response details
| Status code | Description | Response headers |
|---|---|---|
| 200 | Successful | - |
| 400 | Bad Request | - |
| 401 | Access denied | - |
| 403 | Forbidden | - |
| 404 | Not Found | - |
| 409 | Conflict | - |
setUserExpectedLocationsUsingPUT
setUserExpectedLocationsUsingPUT(userid, expectedLocation)
Set expected locations for a user
Sets the list of expected locations for the specified user. Caller requires the USERRBASETTINGS:EDIT permission.
Example
Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| userid | String | The UUID of the user whose expected locations will be updated. | |
| expectedLocation | List<ExpectedLocation> |
Return type
null (empty response body)
Authorization
HTTP request headers
- Content-Type: application/json
- Accept: application/json
HTTP response details
| Status code | Description | Response headers |
|---|---|---|
| 200 | Successful | - |
| 400 | Bad Request | - |
| 401 | Access denied | - |
| 403 | Forbidden | - |
| 404 | Not Found | - |
| 409 | Conflict | - |
updateUserRbaSettingsUsingPUT
updateUserRbaSettingsUsingPUT(userid, userRbaSettings)
Update user risk-based authentication settings
Update the user risk-based authentication settings for the specified user. Caller requires the USERRBASETTINGS:EDIT permission.
Example
Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| userid | String | The UUID of the user whose RBA settings will be updated. | |
| userRbaSettings | UserRbaSettings |
Return type
null (empty response body)
Authorization
HTTP request headers
- Content-Type: application/json
- Accept: application/json
HTTP response details
| Status code | Description | Response headers |
|---|---|---|
| 200 | Successful | - |
| 400 | Bad Request | - |
| 401 | Access denied | - |
| 403 | Forbidden | - |
| 404 | Not Found | - |
| 409 | Conflict | - |