Facts
application/x-www-form-urlencoded application/json Arguments
Optional arguments
trusted_cidrarrayOptionalallow list of IPv4 addresses using cidr notation in the Enterprise organization configuration
trusted_asnsarrayOptionalallow list of Autonomous System Numbers (ASN) in the Enterprise organization configuration
Usage info
Allows Enterprise organization admins to write/overwrite the allow list of IP blocks and ASNs from the enterprise configuration.
If you are adding new IP ranges and ASNs you must include all of the previously added IP ranges and ASNs in your new API call or they will be overwritten.
The token argument is required and is a session token (xoxc- or xoxp-).
Please note that the xoxp- token must be:
- created by an org admin
- have a user token scope of
admin
Additionally, the app using the token must be installed at the org level.
The trusted_asns argument is optional and is an allow list of asns as integers.
The trusted_cidrs argument is optional and is an allow list of IPs using CIDR notation as strings.
Example Request
{
"token":"xoxp-...",
"trusted_cidr":["8.8.8.8/24","8.8.4.4/22"],
"trusted_asn":[34245,8530]
}
Response
The response is a JSON string containing the field ok. Successful writes have a true status while unsuccessful writes that are not errors will return false.
{
"ok": true
}
Errors
This table lists the expected errors that this method could return. However, other errors can be returned in the case where the service is down or other unexpected factors affect processing. Callers should always check the value of the ok parameter in the response.
access_deniedAccess to a resource specified in the request is denied.
accesslimitedAccess to this method is limited on the current network
account_inactiveAuthentication token is for a deleted user or workspace when using a bot token.
deprecated_endpointThe endpoint has been deprecated.
ekm_access_deniedAdministrators have suspended the ability to post a message.
endpoint_unavailableThe requested endpoint is currently unavailable.
enterprise_is_restrictedThe method cannot be called from an Enterprise.
fatal_errorThe server could not complete your operation(s) without encountering a catastrophic error. It's possible some aspect of the operation succeeded before the error was raised.
internal_errorThe server could not complete your operation(s) without encountering an error, likely due to a transient issue on our end. It's possible some aspect of the operation succeeded before the error was raised.
invalid_arg_nameThe method was passed an argument whose name falls outside the bounds of accepted or expected values. This includes very long names and names with non-alphanumeric characters other than _. If you get this error, it is typically an indication that you have made a very malformed API call.
invalid_argumentsThe method was called with invalid arguments.
invalid_array_argThe method was passed an array as an argument. Please only input valid strings.
invalid_authSome aspect of authentication cannot be validated. Either the provided token is invalid or the request originates from an IP address disallowed from making the request.
invalid_charsetThe method was called via a POST request, but the charset specified in the Content-Type header was invalid. Valid charset names are: utf-8 iso-8859-1.
invalid_field_or_datauser attempted to write and invalid field or data to the team config
invalid_form_dataThe method was called via a POST request with Content-Type application/x-www-form-urlencoded or multipart/form-data, but the form data was either missing or syntactically invalid.
invalid_post_typeThe method was called via a POST request, but the specified Content-Type was invalid. Valid types are: application/json application/x-www-form-urlencoded multipart/form-data text/plain.
method_deprecatedThe method has been deprecated.
missing_post_typeThe method was called via a POST request and included a data payload, but the request did not include a Content-Type header.
missing_scopeThe token used is not granted the specific scope permissions required to complete this request.
no_permissionThe workspace token used in this request does not have the permissions necessary to complete the request. Make sure your app is a member of the conversation it's attempting to post a message to.
not_allowed_token_typeThe token type used in this request is not allowed.
not_authedNo authentication token provided.
org_login_requiredThe workspace is undergoing an enterprise migration and will not be available until migration is complete.
ratelimitedThe request has been ratelimited. Refer to the Retry-After header for when to retry the request.
request_timeoutThe method was called via a POST request, but the POST data was either missing or truncated.
service_unavailableThe service is temporarily unavailable
team_access_not_grantedThe token used is not granted the specific workspace access required to complete this request.
team_added_to_orgThe workspace associated with your request is currently undergoing migration to an Enterprise Organization. Web API and other platform operations will be intermittently unavailable until the transition is complete.
token_expiredAuthentication token has expired
token_revokedAuthentication token is for a deleted user or workspace or the app has been removed when using a user token.
two_factor_setup_requiredTwo factor setup is required.
unable_to_process_post_requestThe user sent a malformed post request
unsupported_action_describeThe user specified describe action is unsupported
unsupported_action_putThe user specified put action is unsupported