List expected locations for a user

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

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

Request

Path Parameters

userid stringrequired

The UUID of the user whose expected locations will be returned.

Responses

200

Successful

application/json

Schema

Schema

expectedLocations

object[]

required

The list of expected locations stored for this user.

Array [

city string

The city name--always returned in upper-case.

countryCode string

A two-character (alpha-2) ISO 3166-1 country code.

id string

The UUID of this expected location.

ipAddress string

The IPv4 Address.

isp string

The ISP name--always returned in upper-case.

privateIpAddress boolean

Whether the IP provided is a private IP Address. The value is ignored when adding an ExpectedLocation. It is returned when getting ExpectedLocations if the location has an IP address defined

]

maximumExpectedLocations int32required

The maximum number of expected locations that can be stored for this user.

Example (from schema)

{
  "expectedLocations": [
    {
      "city": "string",
      "countryCode": "string",
      "id": "string",
      "ipAddress": "string",
      "isp": "string",
      "privateIpAddress": true
    }
  ],
  "maximumExpectedLocations": 0
}

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...