get_rocket_users: Retrieve a list of all users in a Rocket.chat server

In paeselhz/rocketeer:

Description

get_rocket_users Gets a dataframe with all the users in a Rocket.chat server.

Usage

get_rocket_users(url, user_id, auth_token)

Arguments

url	The url of the rocket.chat server (has to be complete, with http or https).
user_id	The users ID retrieved from 'get_rocket_credentials'.
auth_token	The users authentication Token retrieved from 'get_rocket_credentials'.

Details

This is a simple function, that connects with the Rocket.chat server and returns a dataframe with information about all users registered.

The return comprises a few information about the users such as: * username = Username used to login. * name = Actual name of the user. * user_id = ID used to identify other users within Rocket.chat. * is_ldap = If this registry comes from LDAP servers or not. * is_active = If this user is still active. * type = Can be one of two, or user, or bot.

Value

The return of this function is a dataframe.

Examples

## Not run: 
get_rocket_users(url        = 'http://localhost:8000/',
                 user_id    = '<ROCKET_USER_ID>',
                 auth_token = '<ROCKET_USER_AUTH_TOKEN>')

## End(Not run)

paeselhz/rocketeer documentation built on Nov. 11, 2019, 1:23 a.m.