Slack v0.23.5 Slack.Web.Admin.Apps View Source
Link to this section Summary
Functions
Approve an app for installation on a workspace
Restrict an app for installation on a workspace
Link to this section Functions
Link to this function
approve(token, optional_params \\ %{}) View Source
Approve an app for installation on a workspace.
Required Params
token
- Authentication token bearing required scopes. ex:xxxx-xxxxxxxxx-xxxx
Optional Params
app_id
- The id of the app to approve. Required ifrequest_id
is missing. ex:A12345
request_id
- The id of the request to approve. Required ifapp_id
is missing. ex:Ar12345
team_id
- The id of the team to approve. Required if your Enterprise Grid org contains more than one workspace. ex:A12345
Errors the API can return:
account_inactive
- Authentication token is for a deleted user or workspace.app_management_app_not_installed_on_org
- The app management app must be installed on the org.ekm_access_denied
- Administrators have suspended the ability to post a message.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.feature_not_enabled
- Returned when the Admin APIs feature is not enabled for this team.invalid_app_id
- Theapp_id
passed was 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_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 aPOST
request, but thecharset
specified in theContent-Type
header was invalid. Valid charset names are:utf-8
iso-8859-1
.invalid_form_data
- The method was called via aPOST
request withContent-Type
application/x-www-form-urlencoded
ormultipart/form-data
, but the form data was either missing or syntactically invalid.invalid_post_type
- The method was called via aPOST
request, but the specifiedContent-Type
was invalid. Valid types are:application/json
application/x-www-form-urlencoded
multipart/form-data
text/plain
.invalid_request_id
- Therequest_id
passed was invalid.is_bot
- This method cannot be called by a bot user.missing_post_type
- The method was called via aPOST
request and included a data payload, but the request did not include aContent-Type
header.missing_scope
- The token used is not granted the specific scope permissions required to complete this request.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_an_admin
- This method is only accessible by org owners and admins.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.request_already_resolved
- The app request has already been resolved.request_id_or_app_id_is_required
- Must include arequest_id
orapp_id
.request_id_required_for_custom_integrations
- Arequest_id
is required for custom integrations.request_timeout
- The method was called via aPOST
request, but thePOST
data was either missing or truncated.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.team_not_found
- Returned when team id is not found.token_revoked
- Authentication token is for a deleted user or workspace or the app has been removed.too_many_ids_provided
- Please provide onlyapp_id
ORrequest_id
.too_many_teams_provided
- Please provide onlyteam_id
ORenterprise_id
.
Link to this function
restrict(token, optional_params \\ %{}) View Source
Restrict an app for installation on a workspace.
Required Params
token
- Authentication token bearing required scopes. ex:xxxx-xxxxxxxxx-xxxx
Optional Params
app_id
- The id of the app to restrict. Required ifrequest_id
is missing. ex:A12345
request_id
- The id of the request to restrict. Required ifapp_id
is missing. ex:Ar12345
team_id
- The id of the team to restrict. Required if your Enterprise Grid org contains more than one workspace. ex:A12345
Errors the API can return:
account_inactive
- Authentication token is for a deleted user or workspace.app_management_app_not_installed_on_org
- The app management app must be installed on the org.ekm_access_denied
- Administrators have suspended the ability to post a message.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.feature_not_enabled
- Returned when the Admin APIs feature is not enabled for this team.invalid_app_id
- Theapp_id
passed was 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_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 aPOST
request, but thecharset
specified in theContent-Type
header was invalid. Valid charset names are:utf-8
iso-8859-1
.invalid_form_data
- The method was called via aPOST
request withContent-Type
application/x-www-form-urlencoded
ormultipart/form-data
, but the form data was either missing or syntactically invalid.invalid_post_type
- The method was called via aPOST
request, but the specifiedContent-Type
was invalid. Valid types are:application/json
application/x-www-form-urlencoded
multipart/form-data
text/plain
.invalid_request_id
- Therequest_id
passed was invalid.is_bot
- This method cannot be called by a bot user.missing_post_type
- The method was called via aPOST
request and included a data payload, but the request did not include aContent-Type
header.missing_scope
- The token used is not granted the specific scope permissions required to complete this request.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_an_admin
- This method is only accessible by org owners and admins.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.request_already_resolved
- The app request has already been resolved.request_id_or_app_id_is_required
- Must include arequest_id
orapp_id
.request_id_required_for_custom_integrations
- Arequest_id
is required for custom integrations.request_timeout
- The method was called via aPOST
request, but thePOST
data was either missing or truncated.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.team_not_found
- Returned when team id is not found.token_revoked
- Authentication token is for a deleted user or workspace or the app has been removed.too_many_ids_provided
- Please provide onlyapp_id
ORrequest_id
.too_many_teams_provided
- Please provide onlyteam_id
ORenterprise_id
.