Login IP Allowlist Config
You need Manage Security permission to manage login ip allowlist configs.
Advanced
- Advanced Manage
GET global/loginIpAllowlistConfig
POST global/loginIpAllowlistConfig:disable
POST global/loginIpAllowlistConfig:enable
PUT global/loginIpAllowlistConfig
Model
Login IP Allowlist Config JSON Format
Login IP Allowlist Config is represented as simple flat JSON objects with the following keys:
Name | Type | Description |
---|---|---|
siteId |
integer | Id of the site. |
isEnabled |
bool | Whether login IP allowlist is enabled or not. |
isLoginIpAllowlistApplicableForMobileAccess |
bool | Whether IP login allows mobile access or not. |
Endpoint
Get a single Login IP Allowlist Config
GET global/loginIpAllowlistConfig
Example
Sample Request:
curl https://api11.comm100.io/v4/global/loginIpAllowlistConfig \
-X
'GET'
\
-H
'Authorization: Bearer {access_token}'
\
Response:
HTTP/1.1 200 OK
Disable the Login IP Allowlist Config
POST global/loginIpAllowlistConfig:disable
Example
Sample Request:
curl https://api11.comm100.io/v4/global/loginIpAllowlistConfig:disable \
-X
'POST'
\
-H
'Authorization: Bearer {access_token}'
\
Response:
HTTP/1.1 200 OK
Enable the Login IP Allowlist Config
POST global/loginIpAllowlistConfig:enable
Example
Sample Request:
curl https://api11.comm100.io/v4/global/loginIpAllowlistConfig:enable \
-X
'POST'
\
-H
'Authorization: Bearer {access_token}'
\
Response:
HTTP/1.1 200 OK
Update the Login IP Allowlist Config
PUT global/loginIpAllowlistConfig
Parameters:
Name | Type | In | Required | Description |
---|---|---|---|---|
isEnabled |
bool | body | no | Whether login IP allowlist is enabled or not. |
isLoginIpAllowlistApplicableForMobileAccess |
bool | body | no | Whether IP login allows mobile access or not. |
Response:
Example
Sample Request:
curl https://api11.comm100.io/v4/global/loginIpAllowlistConfig \
-X
'PUT'
\
-H
'Authorization: Bearer {access_token}'
\
-H
'Content-Type: application/json'
\
-D
'{"isEnabled":false,"isLoginIpAllowlistApplicableForMobileAccess":false}'
Response:
HTTP/1.1 200 OK