Org Webservice

Update login IP allowlist

Update the org-wide login IP allowlist that users flagged with restrictToAllowedLoginIps are limited to

post/api/org/updateLoginIpAllowlist

Request

  • Base URL: https://api2.rhombussystems.com
  • URL: https://api2.rhombussystems.com/api/org/updateLoginIpAllowlist
  • Auth: API key in header x-auth-apikey

Headers

x-auth-scheme'api-token' | 'api' | 'partner-api-token' | 'partner-api' required

Authentication scheme identifier. Use api-token for standard API key authentication, partner-api-token for partner API key authentication. Must be paired with the x-auth-apikey header containing your API key.

Request body

allowedLoginIpRangesstring[] nullable

IP addresses / CIDR ranges that users flagged with restrictToAllowedLoginIps may use the web console from. An empty list clears the allowlist (and lifts the restriction until ranges are configured again).

Example request

{
  "allowedLoginIpRanges": [
    "203.0.113.5",
    "198.51.100.0/24"
  ]
}

Response

OK

errorboolean nullable
errorCodestring nullable

Stable, machine-readable code for the failure (one of the ApiErrorCode catalog) when error is true. Branch on this, not on errorMsg.

errorMsgstring nullable
warningMsgstring nullable

Example response

{
  "org": {
    "companyLogoUuid": "AAAAAAAAAAAAAAAAAAAAAA",
    "keypadLogoUuid": "AAAAAAAAAAAAAAAAAAAAAA",
    "managingPartnerOrgUuid": "AAAAAAAAAAAAAAAAAAAAAA",
    "rhombusKeyLogoUuid": "AAAAAAAAAAAAAAAAAAAAAA",
    "uuid": "AAAAAAAAAAAAAAAAAAAAAA"
  }
}

Changes

No recorded changes to this operation across all 1 revision of this API.