UserRBASettingsApi

Method	HTTP request	Description
delete_user_locations_using_delete	DELETE /api/web/v1/users/{userid}/userlocations	Delete user location history
get_user_rba_settings_using_get	GET /api/web/v1/users/{userid}/userrbasettings	Get user risk-based authentication settings
ip_location_from_ip_address_using_post	POST /api/web/v1/iplocations	Create IP location
list_user_expected_locations_using_get	GET /api/web/v1/users/{userid}/expectedlocations	List expected locations for a user
list_user_locations_using_get	GET /api/web/v1/users/{userid}/userlocations	Get user location history
set_user_expected_locations_using_put	PUT /api/web/v1/users/{userid}/expectedlocations	Set expected locations for a user
update_user_rba_settings_using_put	PUT /api/web/v1/users/{userid}/userrbasettings	Update user risk-based authentication settings

delete_user_locations_using_delete

delete_user_locations_using_delete(userid, request_body)

Delete user location history

Delete one or more entries from a user's location history. Caller requires the USERRBASETTINGS:REMOVE permission.

• Api Key Authentication (AdminAPIAuthentication):

Parameters

Name	Type	Description	Notes
userid	str	The UUID of the user whose location history is to be updated.
request_body	List[str]

Return type

void (empty response body)

Authorization

AdminAPIAuthentication

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	-

get_user_rba_settings_using_get

UserRbaSettings get_user_rba_settings_using_get(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

• Api Key Authentication (AdminAPIAuthentication):

Parameters

Name	Type	Description	Notes
userid	str	The UUID of the user whose RBA settings will be retrieved.

Return type

UserRbaSettings

Authorization

AdminAPIAuthentication

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	-

ip_location_from_ip_address_using_post

IpLocation ip_location_from_ip_address_using_post(ip_location)

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

• Api Key Authentication (AdminAPIAuthentication):

Parameters

Name	Type	Description	Notes
ip_location	IpLocation

Return type

IpLocation

Authorization

AdminAPIAuthentication

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	-

list_user_expected_locations_using_get

UserExpectedLocations list_user_expected_locations_using_get(userid)

List expected locations for a user

Lists the expected locations for the specified user. Caller requires the USERRBASETTINGS:VIEW permission.

Example

• Api Key Authentication (AdminAPIAuthentication):

Parameters

Name	Type	Description	Notes
userid	str	The UUID of the user whose expected locations will be returned.

Return type

UserExpectedLocations

Authorization

AdminAPIAuthentication

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	-

list_user_locations_using_get

List[UserLocation] list_user_locations_using_get(userid)

Get user location history

Get the location history of the specified user. Caller requires the USERRBASETTINGS:VIEW permission.

Example

• Api Key Authentication (AdminAPIAuthentication):

Parameters

Name	Type	Description	Notes
userid	str	The UUID of the user whose location history is to be retrieved.

Return type

List[UserLocation]

Authorization

AdminAPIAuthentication

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	-

set_user_expected_locations_using_put

set_user_expected_locations_using_put(userid, expected_location)

Set expected locations for a user

Sets the list of expected locations for the specified user. Caller requires the USERRBASETTINGS:EDIT permission.

Example

• Api Key Authentication (AdminAPIAuthentication):

Parameters

Name	Type	Description	Notes
userid	str	The UUID of the user whose expected locations will be updated.
expected_location	List[ExpectedLocation]

Return type

void (empty response body)

Authorization

AdminAPIAuthentication

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	-

update_user_rba_settings_using_put

update_user_rba_settings_using_put(userid, user_rba_settings)

Update user risk-based authentication settings

Update the user risk-based authentication settings for the specified user. Caller requires the USERRBASETTINGS:EDIT permission.

Example

• Api Key Authentication (AdminAPIAuthentication):

Parameters

Name	Type	Description	Notes
userid	str	The UUID of the user whose RBA settings will be updated.
user_rba_settings	UserRbaSettings

Return type

void (empty response body)

Authorization

AdminAPIAuthentication

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	-