Packages

A Slack Web & Real Time Messaging API client.

Current section

Files

Jump to
slack_kit priv docs methods functions.distributions.permissions.set.json
Raw

priv/docs/methods/functions.distributions.permissions.set.json

{
"args": {
"function_app_id": {
"desc": "The encoded ID of the app",
"example": "A12345",
"required": false,
"type": "string"
},
"function_callback_id": {
"desc": "The callback ID defined in the function's definition file",
"example": "my_function",
"required": false,
"type": "string"
},
"function_id": {
"desc": "The encoded ID of the function",
"example": "Fn12345",
"required": false,
"type": "string"
},
"org_ids": {
"desc": "List of org IDs to allow for named\\_entities permission",
"example": "E00000001,E00000002,E00000003",
"required": false,
"type": "array"
},
"permission_type": {
"desc": "The type of permission that defines how the function can be distributed _Acceptable values:_ `everyone` `app_collaborators` `named_entities` `system`",
"required": false,
"type": "string"
},
"team_ids": {
"desc": "List of team IDs to allow for named\\_entities permission",
"example": "T00000001,T00000002,T00000003",
"required": false,
"type": "array"
},
"user_ids": {
"desc": "List of encoded user IDs",
"example": "U1234,U2345,U3456",
"required": false,
"type": "array"
}
},
"desc": "Set the access type of a custom slack function and define the users, team or org ids to be granted access if permission\\_type is set to named\\_entities",
"errors": {
"app_not_found": "This app does not exist.",
"function_not_found": "This function does not exist.",
"invalid_named_entities": "One or more of the named entities was not found",
"invalid_permission_type": "This function requires permission\\_type to be set as named\\_entities before adding users.",
"permission_type_required": "`permission_type` is a required input.",
"unknown_method": "This method does not exist.",
"user_not_found": "One or more of the named entities was not found."
},
"rate_limit": {
"label": "Tier 3: 50+ per minute",
"url": "https://docs.slack.dev/apis/web-api/rate-limits"
},
"scopes": {}
}