Login IP Allowlist

You need Manage Security permission to manage login ip allowlist.

Allowed IP List
- Allowed IP List Manage
GET global/loginIpAllowlists
GET global/loginIpAllowlists/{id}
POST global/loginIpAllowlists
PUT global/loginIpAllowlists/{id}
DELETE global/loginIpAllowlists/{id}
Model
Login IP Allowlist JSON Format

Login IP Allowlist is represented as simple flat JSON objects with the following keys:

Name Type Description
ipRangeFrom string Where an IP range starts.
ipRangeTo string Where an IP range ends.
id guid Id of the login IP allowlist.
Endpoint
Get the list of Allowed IP List

GET global/loginIpAllowlists

Parameters:
No Parameters
Response:

An array of   Login IP Allowlist

Example

Sample Request:

curl https://api15.comm100.io/v4/global/loginIpAllowlists \
-X 'GET' \
-H 'Authorization: Bearer {access_token}' \

Response:

 HTTP/1.1 200 OK

[{"ipRangeFrom":"192.168.0.1","ipRangeTo":"192.168.0.100","id":"f7caf92c-34af-487f-a9ce-7f7f6980c437"}]
Get a single Login IP Allowlist

GET global/loginIpAllowlists/{id}

Parameters:
No Parameters
Response:
Example

Sample Request:

curl https://api15.comm100.io/v4/global/loginIpAllowlists/f7caf92c-34af-487f-a9ce-7f7f6980c437 \
-X 'GET' \
-H 'Authorization: Bearer {access_token}' \

Response:

 HTTP/1.1 200 OK

{"ipRangeFrom":"192.168.0.1","ipRangeTo":"192.168.0.100","id":"f7caf92c-34af-487f-a9ce-7f7f6980c437"}
Create a new Login IP Allowlist

POST global/loginIpAllowlists

Parameters:
Name Type In Required Description
ipRangeFrom string body yes Where an IP range starts.
ipRangeTo string body yes Where an IP range ends.
Response:
Example

Sample Request:

curl https://api15.comm100.io/v4/global/loginIpAllowlists \
-X 'POST' \
-H 'Authorization: Bearer {access_token}' \
-H 'Content-Type: application/json' \
-D '{"ipRangeFrom":"192.168.0.1","ipRangeTo":"192.168.0.100"}'

Response:

 HTTP/1.1 201 Created

{"ipRangeFrom":"192.168.0.1","ipRangeTo":"192.168.0.100","id":"f7caf92c-34af-487f-a9ce-7f7f6980c437"}
Update the Login IP Allowlist

PUT global/loginIpAllowlists/{id}

Parameters:
Name Type In Required Description
ipRangeFrom string body yes Where an IP range starts.
ipRangeTo string body yes Where an IP range ends.
Response:
Example

Sample Request:

curl https://api15.comm100.io/v4/global/loginIpAllowlists/f7caf92c-34af-487f-a9ce-7f7f6980c437 \
-X 'PUT' \
-H 'Authorization: Bearer {access_token}' \
-H 'Content-Type: application/json' \
-D '{"ipRangeFrom":"192.168.0.1","ipRangeTo":"192.168.0.100"}'

Response:

 HTTP/1.1 200 OK

{"ipRangeFrom":"192.168.0.1","ipRangeTo":"192.168.0.100","id":"f7caf92c-34af-487f-a9ce-7f7f6980c437"}
Remove the Login IP Allowlist

DELETE global/loginIpAllowlists/{id}

Parameters:
No Parameters
Response:

No Content

Example

Sample Request:

curl https://api15.comm100.io/v4/global/loginIpAllowlists/f7caf92c-34af-487f-a9ce-7f7f6980c437 \
-X 'DELETE' \
-H 'Authorization: Bearer {access_token}' \

Response:

 HTTP/1.1 204 No Content