Current section
Files
Jump to
Current section
Files
lib/slack/web/docs/admin.apps.config.set.json
{
"args": {
"app_id": {
"desc": "The encoded app ID to set the app config for",
"example": "A12345",
"required": true
},
"domain_restrictions": {
"desc": "Domain restrictions for the app. Should be an object with two properties: `urls` and `emails`. Each is an array of strings, and each sets the allowed URLs and emails for connector authorization, respectively.",
"required": false,
"type": "object"
},
"rich_link_preview_type": {
"desc": "Indicates the app-level override for rich link preview. Unsupported for free teams.\n\n_Acceptable values:_ `all_details` `limited_details` `no_preview` `default_to_global_setting`",
"required": false,
"type": "string"
},
"workflow_auth_strategy": {
"desc": "The workflow auth permission. Can be one of `builder_choice` or `end_user_only`.\n\n_Acceptable values:_ `builder_choice` `end_user_only`",
"required": false,
"type": "string"
}
},
"desc": "Set the app config for a connector",
"errors": {
"access_denied": "This actor does not have access to the permissions on this resource.",
"accesslimited": "Access to this method is limited on the current network",
"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.",
"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_app": "App is invalid",
"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 called with invalid arguments.",
"invalid_array_arg": "The method was passed an array as an argument. Please only input valid strings.",
"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.",
"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_domains": "At least one URL or email is invalid",
"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`.",
"invalid_workflow_auth_strategy": "workflow auth strategy is invalid",
"method_deprecated": "The method has been deprecated.",
"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.",
"missing_scope": "The token used is not granted the specific scope permissions required to complete this request.",
"no_domains_provided": "At least one allowed domain must be specified if populating the argument",
"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.",
"not_allowed_token_type": "The token type used in this request is not allowed.",
"not_authed": "No authentication token provided.",
"org_login_required": "The workspace is undergoing an enterprise migration and will not be available until migration is complete.",
"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.",
"restricted_plan_level": "The given parameter is not supported on this team.",
"service_unavailable": "The service is temporarily unavailable",
"team_access_not_granted": "The token used is not granted the specific workspace access required to complete this request.",
"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.",
"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.",
"too_many_domains_provided": "Too many domains provided. Please provide 50 or less for each type of domain",
"two_factor_setup_required": "Two factor setup is required.",
"unknown_method": "This method does not exist.",
"url_restriction_not_supported": "URL restriction is not supported for this app."
}
}