admin.barriers.create

View other methods

Create an Information Barrier

Reference docs Tester

Notices

This API method can only be used on Enterprise Grid workspaces.

Facts

Method access

HTTP

JavaScript

Python

Java

HTTP

GEThttps://slack.com/api/admin.barriers.create

Bolt for Java

app.client().adminBarriersCreate

Bolt for Python

app.client.admin_barriers_create

Bolt for JavaScript

app.client.admin.barriers.create

Required scopes

User tokensadmin.barriers:write

Content types

application/x-www-form-urlencoded

Rate limits

Tier 2

Arguments

Required arguments

token

token

·Required

Authentication token bearing required scopes. Tokens should be passed as an HTTP Authorization header or alternatively, as a POST parameter.

Example

xxxx-xxxxxxxxx-xxxx

barriered_from_usergroup_ids

array

·Required

A list of IDP Groups ids that the primary usergroup is to be barriered from.

primary_usergroup_id

·Required

The id of the primary IDP Group

restricted_subjects

array

·Required

What kind of interactions are blocked by this barrier? For v1, we only support a list of all 3, eg im, mpim, call

Usage info

This Admin API method creates a new information barrier. Similar to admin.barriers.update, it has a unique required argument called restricted_subjects that allows you to block interaction between barriers. Currently you must pass all three im,mpim,call.

Example responses

Common successful response

The response includes primary_usergroup, enterprise_id, barrier_id

{
    "ok": true,
    "barrier": {
        "id": "Ba03T70KB2H3",
        "enterprise_id": "E03055H6DAS",
        "primary_usergroup": {
            "id": "S03TZK4A9H6",
            "name": "Company That Pays Contracting Teams"
        },
        "barriered_from_usergroups": [
            {
                "id": "S03TNHGAUGZ",
                "name": "Another External Contracting Team"
            },
            {
                "id": "S03TNHF56UR",
                "name": "External Contracting Team"
            }
        ],
        "restricted_subjects": [
            "im",
            "mpim",
            "call"
        ],
        "date_update": 1660224825
    }
}

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 params in the response.

Error	Description
`barrier_already_exists`	There already exists another barrier restricting activity between two or more of your requested usergroups.
`barriered_from_usergroups_not_found`	One or more of the ids passed in for barriered_from_usergroup_ids can’t be found.
`feature_not_enabled`	The information barrier feature is not enabled, please reach out to your CSM.
`invalid_restricted_subjects`	The restricted subjects provided are invalid or not currently supported.
`not_an_admin`	The token provided is not associated with an org admin.
`primary_usergroup_not_found`	The id passed in for primary_usergroup_id can’t be found.
`access_denied`	Access to a resource specified in the request is denied.
`account_inactive`	Authentication token is for a deleted user or workspace when using a `bot` token.
`deprecated_endpoint`	The endpoint has been deprecated.
`ekm_access_denied`	Administrators have suspended the ability to post a message.
`enterprise_is_restricted`	The method cannot be called from an Enterprise.
`invalid_auth`	Some 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.
`is_bot`	This method cannot be called by a legacy bot.
`method_deprecated`	The method has been deprecated.
`missing_scope`	The token used is not granted the specific scope permissions required to complete this request.
`not_allowed_token_type`	The token type used in this request is not allowed.
`not_authed`	No authentication token provided.
`no_permission`	The 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.
`org_login_required`	The workspace is undergoing an enterprise migration and will not be available until migration is complete.
`token_expired`	Authentication token has expired
`token_revoked`	Authentication token is for a deleted user or workspace or the app has been removed when using a `user` token.
`two_factor_setup_required`	Two factor setup is required.
`accesslimited`	Access to this method is limited on the current network
`fatal_error`	The 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_error`	The 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_name`	The 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_arguments`	The method was either called with invalid arguments or some detail about the arguments passed is invalid, which is more likely when using complex arguments like blocks or attachments.
`invalid_array_arg`	The method was passed an array as an argument. Please only input valid strings.
`invalid_charset`	The 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_form_data`	The 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_type`	The 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`.
`missing_post_type`	The method was called via a `POST` request and included a data payload, but the request did not include a `Content-Type` header.
`ratelimited`	The request has been ratelimited. Refer to the `Retry-After` header for when to retry the request.
`request_timeout`	The method was called via a `POST` request, but the `POST` data was either missing or truncated.
`service_unavailable`	The service is temporarily unavailable
`team_added_to_org`	The 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.

Warnings

This table lists the expected warnings that this method will return. However, other warnings can be returned in the case where the service is experiencing unexpected trouble.

Warning	Description
`missing_charset`	The method was called via a `POST` request, and recommended practice for the specified `Content-Type` is to include a `charset` parameter. However, no `charset` was present. Specifically, non-form-data content types (e.g. `text/plain`) are the ones for which `charset` is recommended.
`superfluous_charset`	The method was called via a `POST` request, and the specified `Content-Type` is not defined to understand the `charset` parameter. However, `charset` was in fact present. Specifically, form-data content types (e.g. `multipart/form-data`) are the ones for which `charset` is superfluous.

API response

URL

POST body

Submit your arguments to see the API response