Slack - get user list
Search form
Description - List the Users in your group, team, or workspace
Runtime Class - com.ibi.agents.XDXSlackUsersList
Configuration
This action requires a Generics Configuration as well as the following required parameters.
Parameter Groups
Parameter Type Description Maximum Items: string The maximum number of items to return. Fewer than the requested number of items may be returned, even if the end of the list hasn't been reached. The dfault is 100.
Information Start: string Start for a multipage display of retrieved information. Use Slack response Json key nextCursor value to continue a response. Default value fetches the first page; see https://api.slack.com/docs/pagination
Include Presence Data: boolean Whether to include presence data in the output. Defaults to false. Setting this to true reduces performance.
Include Locale: boolean if true the locale of the channel is included. The default is false.
* - denotes required
Parameter Type Description * Namespace: string Name of the special registers namespace to prepend to any created register or variable returned by the object.
* - denotes required
Parameter Type Description On Success: string If operation was successful, the object will return the following document type.
Select from one of the following options:
- Status Document {status} - output status
- Results Document {results} - output response in JSON format
- Input Document {inputDocument} - output the input document in JSON format
On Failure: string If operation in unsuccessful, should the agent return the standard error document, or should it return its input?
Select from one of the following options:
- Status Document {status} - The status document of execution.
- Results Document {results} - The JSON results document of execution.
- Input Document {inputDocument} - The original document passed into the object.
- Error Document {errorDocument} - The error document produced by the object.
* - denotes required
Output Events
Runtime Class - com.ibi.agents.XDXSlackUsersList
Configuration
This action requires a Generics Configuration as well as the following required parameters.
Parameter Groups
Parameter Type Description Maximum Items: string The maximum number of items to return. Fewer than the requested number of items may be returned, even if the end of the list hasn't been reached. The dfault is 100.
Information Start: string Start for a multipage display of retrieved information. Use Slack response Json key nextCursor value to continue a response. Default value fetches the first page; see https://api.slack.com/docs/pagination
Include Presence Data: boolean Whether to include presence data in the output. Defaults to false. Setting this to true reduces performance.
Include Locale: boolean if true the locale of the channel is included. The default is false.
* - denotes required
Parameter Type Description * Namespace: string Name of the special registers namespace to prepend to any created register or variable returned by the object.
* - denotes required
Parameter Type Description On Success: string If operation was successful, the object will return the following document type.
Select from one of the following options:
- Status Document {status} - output status
- Results Document {results} - output response in JSON format
- Input Document {inputDocument} - output the input document in JSON format
On Failure: string If operation in unsuccessful, should the agent return the standard error document, or should it return its input?
Select from one of the following options:
- Status Document {status} - The status document of execution.
- Results Document {results} - The JSON results document of execution.
- Input Document {inputDocument} - The original document passed into the object.
- Error Document {errorDocument} - The error document produced by the object.
* - denotes required
Output Events
Configuration
This action requires a Generics Configuration as well as the following required parameters.Parameter Groups
| Parameter | Type | Description | |
|---|---|---|---|
| Maximum Items: | string | The maximum number of items to return. Fewer than the requested number of items may be returned, even if the end of the list hasn't been reached. The dfault is 100. | Information Start: | string | Start for a multipage display of retrieved information. Use Slack response Json key nextCursor value to continue a response. Default value fetches the first page; see https://api.slack.com/docs/pagination | Include Presence Data: | boolean | Whether to include presence data in the output. Defaults to false. Setting this to true reduces performance. | Include Locale: | boolean | if true the locale of the channel is included. The default is false. |
* - denotes required
| Parameter | Type | Description | |
|---|---|---|---|
| * | Namespace: | string | Name of the special registers namespace to prepend to any created register or variable returned by the object. |
* - denotes required
| Parameter | Type | Description | |
|---|---|---|---|
| On Success: | string | If operation was successful, the object will return the following document type.
Select from one of the following options:
|
On Failure: | string | If operation in unsuccessful, should the agent return the standard error document, or should it return its input?
Select from one of the following options:
|
* - denotes required
Output Events
| Name | Description |
|---|---|
| onAccountInactive | Authentication token is for a deleted user or workspace. |
| onActionProhibited | the team associated with your request has some kind of restriction |
| onComplianceExportsPreventDeletion | Compliance exports are on, messages can not be deleted. |
| onFatalError | 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. |
| onInvalidAuth | 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. |
| onIsArchived | Channel has been archived. |
| onMissingScope | Authorization prived does not have the required scope for the request. See Slack results JSON key "needed". |
| OnMessageTooLong | Message text is too long |
| onNoPermission | 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. |
| onNotAuthorized | No authentication token provided. |
| onLoginRequired | The workspace is undergoing an enterprise migration and will not be available until migration is complete. |
| onRateLimited | Application has posted too many messages, read 'https://api.slack.com/docs/rate-limits' documentation for more information |
| onRequestTimeout | The method was called via a POST request, but the POST data was either missing or truncated. |
| onRestrictedAction | Workspace preference prevents the authenticated user from posting. |
| onRollupError | rolluop_error |
| onTeamAddedToOrg | 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. |
| onTokenRevoked | Authentication token is for a deleted user or workspace or the app has been removed. |
| onTooManyAttachments | Too many attachments were provided with this message. A maximum of 100 attachments are allowed on a message. |
| onUserNotFound | the user used in your request does not actually exist. |
| onFailInitialization | XDXSlack agent initialization error occurred. |
| onFailConnect | Could not connect to the external system. |
| onFailNhttpErrorOccurred | fail_nhttp_error_occurred |
| onFailSlackRequestProcessing | An error occurred while processing the Slack request. |
| onFailSlackResponseProcessing | An error occurred while processing the Slack response. |
| unknown_error | the API returned an undocumented error response. See resonse JSON key error. |
| onInvalidNameSpecials | The Value passed for name contained disallowed special characters or upper case characters. Conversation names can only contain lowercase letters, numbers, hyphens, and underscores, and must be 21 characters or less. |
| onInvalidUsers | At least one of the values passed for user_ids was empty or invalid. |
| onUserIsBot | This method cannot be called by a bot user. |
| onUserIsUltraRestricted | This method cannot be called by a single channel guest. |