en-US/about_poshbox.Help.txt
|
TOPIC
about_poshbox SHORT DESCRIPTION This module allows administrators to administrate and completely automate an enterprise box environment. LONG DESCRIPTION This module allows administrators to administrate and completely automate an enterprise box environment. This module is notably different from other Box Powershell modules in that this module uses OAuth 2.0 with JWT (JSON Web Token) authentication to authenticate to box, which it is able to do because of its use of the Box Windows sdk. This means that authenticating to box can be fully automated and requires no user input, but there are some prerequisites that are needed prior to using this module. For more information, please see the project page (https://github.com/whiggs/PoshBox#box-environment-configuration) NOTE Due to the fact that this module utilizes the box windows sdk, it inherits the same (at least what I perceive to be) annoyances. The main annoyance is the fact that the numerous box objects returned by the box windows sdk are not returned with all of its properties visible by default. This essentially means that the box windows sdk needs to be told what particular properties of a box object should be returned as part of the command to retrieve said object. Throughout this module, almost all of the functions have a "fields" parameter which is meant to allow for users to select which properties (populated in an array of strings) of the box object that is returned will be visible . Therefore, the values which this parameter accepts depends on the box object that is returned when that function is run. Then, you can investigate the properties of the object by looking up the box object's source code. In the help documentation, I have included the box object returned by every function and the url to the associated box object's source code. TROUBLESHOOTING NOTE EXAMPLES KEYWORDS SEE ALSO https://github.com/whiggs/PoshBox https://developer.box.com/reference https://github.com/box/box-windows-sdk-v2 |