{ "opencollection": "1.0.0", "info": { "name": "Slack Admin Access Users API", "version": "1.0" }, "items": [ { "info": { "name": "Users", "type": "folder" }, "items": [ { "info": { "name": "Slack Post Admin Users Assign", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/admin.users.assign", "headers": [ { "name": "token", "value": "" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Add an Enterprise user to a workspace." }, { "info": { "name": "Slack Post Admin Users Invite", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/admin.users.invite", "headers": [ { "name": "token", "value": "" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Invite a user to a workspace." }, { "info": { "name": "Slack Get Admin Users List", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/admin.users.list", "headers": [ { "name": "token", "value": "" } ], "params": [ { "name": "team_id", "value": "", "type": "query", "description": "The ID (`T1234`) of the workspace." }, { "name": "cursor", "value": "", "type": "query", "description": "Set `cursor` to `next_cursor` returned by the previous call to list items in the next page." }, { "name": "limit", "value": "", "type": "query", "description": "Limit for how many users to be retrieved per page" } ] }, "docs": "List users on a workspace" }, { "info": { "name": "Slack Post Admin Users Remove", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/admin.users.remove", "headers": [ { "name": "token", "value": "" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Remove a user from a workspace." }, { "info": { "name": "Slack Post Admin Users Session Invalidate", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/admin.users.session.invalidate", "headers": [ { "name": "token", "value": "" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Invalidate a single session for a user by session_id" }, { "info": { "name": "Slack Post Admin Users Session Reset", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/admin.users.session.reset", "headers": [ { "name": "token", "value": "" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Wipes all valid sessions on all devices for a given user" }, { "info": { "name": "Slack Post Admin Users Setadmin", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/admin.users.setAdmin", "headers": [ { "name": "token", "value": "" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Set an existing guest, regular user, or owner to be an admin user." }, { "info": { "name": "Slack Post Admin Users Setexpiration", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/admin.users.setExpiration", "headers": [ { "name": "token", "value": "" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Set an expiration for a guest user" }, { "info": { "name": "Slack Post Admin Users Setowner", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/admin.users.setOwner", "headers": [ { "name": "token", "value": "" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Set an existing guest, regular user, or admin user to be a workspace owner." }, { "info": { "name": "Slack Post Admin Users Setregular", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/admin.users.setRegular", "headers": [ { "name": "token", "value": "" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Set an existing guest user, admin user, or owner to be a regular user." }, { "info": { "name": "Slack Get Apps Permissions Users List", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/apps.permissions.users.list", "params": [ { "name": "token", "value": "", "type": "query", "description": "Authentication token. Requires scope: `none`" }, { "name": "cursor", "value": "", "type": "query", "description": "Paginate through collections of data by setting the `cursor` parameter to a `next_cursor` attribute returned by a previous request's `response_metadata`. Default value fetches the first \"page\" of the collection. See [pagination](/docs/pagination) for more detail." }, { "name": "limit", "value": "", "type": "query", "description": "The maximum number of items to return." } ] }, "docs": "Returns list of user grants and corresponding scopes this app has on a team." }, { "info": { "name": "Slack Get Apps Permissions Users Request", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/apps.permissions.users.request", "params": [ { "name": "token", "value": "", "type": "query", "description": "Authentication token. Requires scope: `none`" }, { "name": "scopes", "value": "", "type": "query", "description": "A comma separated list of user scopes to request for" }, { "name": "trigger_id", "value": "", "type": "query", "description": "Token used to trigger the request" }, { "name": "user", "value": "", "type": "query", "description": "The user this scope is being requested for" } ] }, "docs": "Enables an app to trigger a permissions modal to grant an app access to a user access scope." }, { "info": { "name": "Get OpenID Connect User Info", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/openid.connect.userInfo", "params": [ { "name": "token", "value": "", "type": "query", "description": "OpenID Connect access token." } ] }, "docs": "Retrieves identity information about a user authenticated via Sign in with Slack." }, { "info": { "name": "Slack Post User Groups Create", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/usergroups.create", "headers": [ { "name": "token", "value": "" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Create a User Group" }, { "info": { "name": "Slack Post User Groups Disable", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/usergroups.disable", "headers": [ { "name": "token", "value": "" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Disable an existing User Group" }, { "info": { "name": "Slack Post User Groups Enable", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/usergroups.enable", "headers": [ { "name": "token", "value": "" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Enable a User Group" }, { "info": { "name": "Slack Get User Groups List", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/usergroups.list", "params": [ { "name": "include_users", "value": "", "type": "query", "description": "Include the list of users for each User Group." }, { "name": "token", "value": "", "type": "query", "description": "Authentication token. Requires scope: `usergroups:read`" }, { "name": "include_count", "value": "", "type": "query", "description": "Include the number of users in each User Group." }, { "name": "include_disabled", "value": "", "type": "query", "description": "Include disabled User Groups." } ] }, "docs": "List all User Groups for a team" }, { "info": { "name": "Slack Post User Groups Update", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/usergroups.update", "headers": [ { "name": "token", "value": "" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Update an existing User Group" }, { "info": { "name": "Slack Get User Groups Users List", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/usergroups.users.list", "params": [ { "name": "token", "value": "", "type": "query", "description": "Authentication token. Requires scope: `usergroups:read`" }, { "name": "include_disabled", "value": "", "type": "query", "description": "Allow results that involve disabled User Groups." }, { "name": "usergroup", "value": "", "type": "query", "description": "The encoded ID of the User Group to update." } ] }, "docs": "List all users in a User Group" }, { "info": { "name": "Slack Post User Groups Users Update", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/usergroups.users.update", "headers": [ { "name": "token", "value": "" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Update the list of users for a User Group" }, { "info": { "name": "Slack Get Users Conversations", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/users.conversations", "params": [ { "name": "token", "value": "", "type": "query", "description": "Authentication token. Requires scope: `conversations:read`" }, { "name": "user", "value": "", "type": "query", "description": "Browse conversations by a specific user ID's membership. Non-public channels are restricted to those where the calling user shares membership." }, { "name": "types", "value": "", "type": "query", "description": "Mix and match channel types by providing a comma-separated list of any combination of `public_channel`, `private_channel`, `mpim`, `im`" }, { "name": "exclude_archived", "value": "", "type": "query", "description": "Set to `true` to exclude archived channels from the list" }, { "name": "limit", "value": "", "type": "query", "description": "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. Must be an integer no larger than 1000." }, { "name": "cursor", "value": "", "type": "query", "description": "Paginate through collections of data by setting the `cursor` parameter to a `next_cursor` attribute returned by a previous request's `response_metadata`. Default value fetches the first \"page\" of the collection. See [pagination](/docs/pagination) for more detail." } ] }, "docs": "List conversations the calling user may access." }, { "info": { "name": "Slack Post Users Deletephoto", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/users.deletePhoto", "body": { "type": "form-urlencoded", "data": [ { "name": "token", "value": "" } ] } }, "docs": "Delete the user profile photo" }, { "info": { "name": "Slack Get Users Getpresence", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/users.getPresence", "params": [ { "name": "token", "value": "", "type": "query", "description": "Authentication token. Requires scope: `users:read`" }, { "name": "user", "value": "", "type": "query", "description": "User to get presence info on. Defaults to the authed user." } ] }, "docs": "Gets user presence information." }, { "info": { "name": "Slack Get Users Identity", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/users.identity", "params": [ { "name": "token", "value": "", "type": "query", "description": "Authentication token. Requires scope: `identity.basic`" } ] }, "docs": "Get a user's identity." }, { "info": { "name": "Slack Get Users Info", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/users.info", "params": [ { "name": "token", "value": "", "type": "query", "description": "Authentication token. Requires scope: `users:read`" }, { "name": "include_locale", "value": "", "type": "query", "description": "Set this to `true` to receive the locale for this user. Defaults to `false`" }, { "name": "user", "value": "", "type": "query", "description": "User to get info on" } ] }, "docs": "Gets information about a user." }, { "info": { "name": "Slack Get Users List", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/users.list", "params": [ { "name": "token", "value": "", "type": "query", "description": "Authentication token. Requires scope: `users:read`" }, { "name": "limit", "value": "", "type": "query", "description": "The maximum number of items to return. Fewer than the requested number of items may be returned, even if the end of the users list hasn't been reached. Providing no `limit` value will result in Slack attempting to deliver you the entire result set. If the collection is too large you may experience `limit_required` or HTTP 500 errors." }, { "name": "cursor", "value": "", "type": "query", "description": "Paginate through collections of data by setting the `cursor` parameter to a `next_cursor` attribute returned by a previous request's `response_metadata`. Default value fetches the first \"page\" of the collection. See [pagination](/docs/pagination) for more detail." }, { "name": "include_locale", "value": "", "type": "query", "description": "Set this to `true` to receive the locale for users. Defaults to `false`" } ] }, "docs": "Lists all users in a Slack team." }, { "info": { "name": "Slack Get Users Lookupbyemail", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/users.lookupByEmail", "params": [ { "name": "token", "value": "", "type": "query", "description": "Authentication token. Requires scope: `users:read.email`" }, { "name": "email", "value": "", "type": "query", "description": "An email address belonging to a user in the workspace" } ] }, "docs": "Find a user with an email address." }, { "info": { "name": "Slack Get Users Profile Get", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/users.profile.get", "params": [ { "name": "token", "value": "", "type": "query", "description": "Authentication token. Requires scope: `users.profile:read`" }, { "name": "include_labels", "value": "", "type": "query", "description": "Include labels for each ID in custom profile fields" }, { "name": "user", "value": "", "type": "query", "description": "User to retrieve profile info for" } ] }, "docs": "Retrieves a user's profile information." }, { "info": { "name": "Slack Post Users Profile Set", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/users.profile.set", "headers": [ { "name": "token", "value": "" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Set the profile information for a user." }, { "info": { "name": "Slack Post Users Setactive", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/users.setActive", "headers": [ { "name": "token", "value": "" } ] }, "docs": "Marked a user as active. Deprecated and non-functional." }, { "info": { "name": "Slack Post Users Setphoto", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/users.setPhoto", "body": { "type": "form-urlencoded", "data": [ { "name": "token", "value": "" }, { "name": "crop_w", "value": "" }, { "name": "crop_x", "value": "" }, { "name": "crop_y", "value": "" }, { "name": "image", "value": "" } ] } }, "docs": "Set the user profile photo" }, { "info": { "name": "Slack Post Users Setpresence", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/users.setPresence", "headers": [ { "name": "token", "value": "" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Manually sets user presence." } ] } ], "bundled": true }