mstrio (version 11.2.0)

connect_mstr: Create a MicroStrategy REST API connection

Description

Establishes and creates a connection with the MicroStrategy REST API.

Usage

connect_mstr(base_url, username, password, project_name = NULL,
  project_id = NULL, login_mode = 1, ssl_verify = TRUE)

Arguments

base_url

URL of the MicroStrategy REST API server

username

Username

password

Password

project_name

Name of the project you intend to connect to. Case-sensitive

project_id

ID of the project you intend to connect to

login_mode

Specifies the authentication mode to use. Supported authentication modes are Standard (1) (default) or LDAP (16)

ssl_verify

If TRUE (default), verifies the server's SSL certificates with each request

Value

A connection object to use in subsequent requests

Examples

# NOT RUN {
# Connect to a MicroStrategy environment
con <- connect_mstr(base_url = "https://demo.microstrategy.com/MicroStrategyLibrary/api",
                    username = "user",
                    password = "password",
                    project_name = "Financial Reporting")

# A good practice is to disconnect once you're done
# In case you forget, the server will disconnect the session after some time has passed
close(con)
# }