You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Add OpenAPI documentation for the new IP Allowlist API:
- GET /ip_allowlist - Retrieve current IP allowlist settings
- PUT /ip_allowlist - Update IP allowlist settings
Includes:
- ip_allowlist schema for response
- ip_allowlist_request schema for request body
- IP Allowlist tag with description
- Examples for success and error responses
- Documentation for lockout protection feature
- Clear explanation of IP/CIDR format for allowlist entries
Requires `manage_ip_allowlist` OAuth scope.
🤖 Generated with [Claude Code](https://claude.com/claude-code)
Co-Authored-By: Claude <noreply@anthropic.com>
The API will reject updates that would lock out the caller's IP address. Ensure your current IP is included in the allowlist when enabling the feature.
2690
+
{% /admonition %}
2691
+
responses:
2692
+
'200':
2693
+
description: Successful response
2694
+
content:
2695
+
application/json:
2696
+
examples:
2697
+
Successful:
2698
+
value:
2699
+
type: ip_allowlist
2700
+
enabled: true
2701
+
ip_allowlist:
2702
+
- "192.168.1.0/24"
2703
+
- "10.0.0.1"
2704
+
schema:
2705
+
"$ref": "#/components/schemas/ip_allowlist"
2706
+
'401':
2707
+
description: Unauthorized
2708
+
content:
2709
+
application/json:
2710
+
examples:
2711
+
Unauthorized:
2712
+
value:
2713
+
type: error.list
2714
+
request_id: a1b2c3d4-e5f6-7890-abcd-ef1234567890
2715
+
errors:
2716
+
- code: unauthorized
2717
+
message: Access Token Invalid
2718
+
schema:
2719
+
"$ref": "#/components/schemas/error"
2720
+
'422':
2721
+
description: Validation error
2722
+
content:
2723
+
application/json:
2724
+
examples:
2725
+
Lockout Protection:
2726
+
value:
2727
+
type: error.list
2728
+
request_id: a1b2c3d4-e5f6-7890-abcd-ef1234567890
2729
+
errors:
2730
+
- code: parameter_invalid
2731
+
message: Your IP (1.2.3.4) is not on the allowlist. Saving would lock you out of this workspace.
description: IP allowlist settings for the workspace.
19707
+
properties:
19708
+
type:
19709
+
type: string
19710
+
description: String representing the object's type. Always has the value `ip_allowlist`.
19711
+
example: ip_allowlist
19712
+
enabled:
19713
+
type: boolean
19714
+
description: Whether the IP allowlist is enabled for the workspace.
19715
+
example: true
19716
+
ip_allowlist:
19717
+
type: array
19718
+
description: |
19719
+
List of allowed IP addresses and/or IP ranges in CIDR notation.
19720
+
Examples:
19721
+
- Single IP: `192.168.0.1`
19722
+
- IP range: `192.168.0.1/24` (allows 192.168.0.0 - 192.168.0.255)
19723
+
items:
19724
+
type: string
19725
+
example:
19726
+
- "192.168.1.0/24"
19727
+
- "10.0.0.1"
19728
+
ip_allowlist_request:
19729
+
title: IP Allowlist Request
19730
+
type: object
19731
+
description: Request body for updating IP allowlist settings.
19732
+
properties:
19733
+
enabled:
19734
+
type: boolean
19735
+
description: Whether to enable the IP allowlist.
19736
+
example: true
19737
+
ip_allowlist:
19738
+
type: array
19739
+
description: |
19740
+
List of allowed IP addresses and/or IP ranges in CIDR notation.
19741
+
Examples:
19742
+
- Single IP: `192.168.0.1`
19743
+
- IP range: `192.168.0.1/24` (allows 192.168.0.0 - 192.168.0.255)
19744
+
items:
19745
+
type: string
19746
+
example:
19747
+
- "192.168.1.0/24"
19748
+
- "10.0.0.1"
19590
19749
intercom_version:
19591
19750
description: Intercom API version.</br>By default, it's equal to the version
19592
19751
set in the app package.
@@ -22406,6 +22565,15 @@ tags:
22406
22565
description: Everything about your Help Center
22407
22566
- name: Internal Articles
22408
22567
description: Everything about your Internal Articles
22568
+
- name: IP Allowlist
22569
+
description: |
22570
+
Manage IP allowlist settings for your workspace.
22571
+
22572
+
The IP Allowlist API allows you to configure which IP addresses are allowed to access the Intercom API and web application for your workspace. This is useful for restricting access to your Intercom workspace to specific corporate networks or VPNs.
0 commit comments