Sharepoint Integration

SharePoint File Transfer Utilities

SharePoint Credential Protocols

The following credential protocols are available to access a SharePoint service:

• SharePointSAML SAML, user login (type:Password)
  SAML based access, can be used without further configuration by the administrator on the SharePoint server.
  A Limitation of this protocol is that it does not support multi factor authentication (MFA)
  
• AzureADUserLogin Azure AD user login (type:Password)
  Credential protocol to login via Azure Active Directory (AzureAD)
  Requirements:
  Azure AD app has to be registered in Microsoft Azure portal (https://portal.azure.com/)
  Application (client) ID and Directory (tenant) ID is needed to access this app
  Limitation: No support for multi factor authentication (MFA)
  
• AzureADCert Azure AD private key certificate (PKCS #12) (type:Certificate)
  Credential protocol that uses PKCS #12 certificate files with private key (.pfx) to allow access to SharePoint services.
  Requirements:
  Azure Active Directory (Azure AD) app has to be registered in Microsoft Azure portal (https://portal.azure.com/)
  Application (client) ID and Directory (tenant) ID is needed to access this app
  A certificate file with the public key (.cer) has to be uploaded to the Azure AD
  
• AzureADClientSecret Azure AD client secret (type:Password)
  Credential protocol to allow access to SharePoint services by generated client secret.
  Limitation:
  It was not tested by Redwood as its AzureAD subscription does not support this authentication method for SharePoint services
  Requirements:
  Azure Active Directory (Azure AD) app has to be registered in Microsoft Azure portal (https://portal.azure.com/)
  Application (client) ID and Directory (tenant) ID is needed to access this app
  In AzureAD a client secret has to be generated and used for the Configure process to create the credential
  
• login Default login protocol.
  

The login protocol is supported for manually created credentials only (legacy). The Configure process does not support it, please use SharePointSAML or AzureADUserLogin instead.

JobDefinition: Sharepoint_Configure

Configure access to SharePoint

Is used to create credentials that allows access to SharePoint service identified by user name and credential endpoint or by certificate common name.

Parameters:

• OVERWRITE_EXISTING_CREDENTIAL Overwrite existing credential
  If false and credential already exists then the configuration will fail
  Simple Constraint: { true,false }
  Default: false
  
• CREDENTIAL_PROTOCOL Credential protocol name
  Name of the used credential protocol
  Simple Constraint: { SharePointSAML,AzureADUserLogin,AzureADCert,AzureADClientSecret }
  
• USER_NAME User name (email adress) (optional)
  Email address of the SharePoint user
  
• PASSWORD Login/certificate password/passphrase (optional)
  Login password or certificate passphrase
  
• PKCS12_CERT_FILE PKCS #12 certificate file (optional, in/out)
  PKCS #12 certificate file that will be used for AzureAD authentication,
  the file will be overwritten with random data as soon as the configure process has been executed
  
• PKCS12_CERT_COMMON_NAME Common name (Certificate) (optional)
  Common name of the AzureAD certificate
  
• AZUREAD_CLIENT_ID AzureAD Application (client) ID (optional)
  AzureAD Application (client) ID
  
• AZUREAD_TENANT_ID AzureAD Directory (tenant) ID (optional)
  AzureAD Directory (tenant) ID
  
• SITE_URL Site URL (optional)
  Site URL to the SharePoint server
  Example https://example.sharepoint.com/sites/TestSite for AzureAD based connections
  https://example-my.sharepoint.com/personal/jondoe_example_onmicrosoft_com
  or for SAML based connections
  
• OUT_CREDENTIAL_BK Credential business key (out)
  Business key of the credential that was created
  

JobDefinition: Sharepoint_Upload_File

Upload To SharePoint

Parameters:

• SITE_URL Sharepoint site URL
  Site URL to the SharePoint server
  Example https://example.sharepoint.com/sites/TestSite for AzureAD based connections
  https://example-my.sharepoint.com/personal/jondoe_example_onmicrosoft_com
  or for SAML based connections
  
• CREDENTIAL_PROTOCOL Credential protocol name
  Name of the used credential protocol
  Simple Constraint: { SharePointSAML,AzureADUserLogin,AzureADCert,AzureADClientSecret,login }
  
• USER_NAME User name (email adress) (optional)
  Email address of the SharePoint user
  
• COMMON_NAME AzureAD common name (optional)
  Common name of the AzureAD certificate
  
• FROM_FILE File to upload
  File to upload to SharePoint server
  
• TO_DIRECTORY_PATH To SharePoint directory path (server relative path)
  Destination path (server relative path) of the directory the file gets uploaded to
  
• OVERWRITE Overwrite existing file
  Should an existing file with the same name at the destination be overwritten
  Simple Constraint: { true,false }
  Default: false
  
• CREATE_MISSING_DIRECTORIES Create missing directories
  If true and a file should be uploaded to a directory that does not yet exist, then all missing directories in the path will be created. Otherwise upload will fail with an error.
  Simple Constraint: { true,false }
  Default: false
  
• TO_FILENAME Optional filename for the uploaded file (optional)
  Optional filename for the uploaded file, if not set then the original filename will be kept
  
• OUT_URL URL of the uploaded file (out)
  URL of the uploaded file
  

JobDefinition: Sharepoint_Download_File

Download from SharePoint

Parameters:

• SITE_URL Sharepoint site URL
  Site URL to the SharePoint server
  Example https://example.sharepoint.com/sites/TestSite for AzureAD based connections
  https://example-my.sharepoint.com/personal/jondoe_example_onmicrosoft_com
  or for SAML based connections
  
• CREDENTIAL_PROTOCOL Credential protocol name
  Name of the used credential protocol
  Simple Constraint: { SharePointSAML,AzureADUserLogin,AzureADCert,AzureADClientSecret,login }
  
• USER_NAME User name (email adress) (optional)
  Email address of the SharePoint user
  
• COMMON_NAME AzureAD common name (optional)
  Common name of the AzureAD certificate
  
• FROM_PATH From SharePoint file path (server relative path)
  Server relative path to the file that will be downloaded
  
• TO_FILENAME Optional filename for the downloaded file (optional)
  Optional filename for the downloaded file, if not set then the original filename will be kept
  
• DOWNLOADED_FILE Downloaded File (out)
  Downloaded File
  

JobDefinition: Sharepoint_Delete_File

Delete file on SharePoint server

Parameters:

• SITE_URL Sharepoint site URL
  Site URL to the SharePoint server
  Example https://example.sharepoint.com/sites/TestSite for AzureAD based connections
  https://example-my.sharepoint.com/personal/jondoe_example_onmicrosoft_com
  or for SAML based connections
  
• CREDENTIAL_PROTOCOL Credential protocol name
  Name of the used credential protocol
  Simple Constraint: { SharePointSAML,AzureADUserLogin,AzureADCert,AzureADClientSecret,login }
  
• USER_NAME User name (email adress) (optional)
  Email address of the SharePoint user
  
• COMMON_NAME AzureAD common name (optional)
  Common name of the AzureAD certificate
  
• FILE_PATH_TO_DELETE Path to SharePoint file to delete (server relative path) (optional)
  Server relative path to the file that will be deleted
  
• DIR_PATH_TO_DELETE Path to SharePoint directory to delete (server relative path) (optional)
  Server relative path to the directory that will be deleted
  
• RECURSIVE Recursive directory deletion
  True allows to delete directories if they are not empty, otherwise deletion will fail with an error
  Simple Constraint: { true,false }
  Default: false
  

JobDefinition: Sharepoint_Move_File

Move File on SharePoint server

Parameters:

• SITE_URL Sharepoint site URL
  Site URL to the SharePoint server
  Example https://example.sharepoint.com/sites/TestSite for AzureAD based connections
  https://example-my.sharepoint.com/personal/jondoe_example_onmicrosoft_com
  or for SAML based connections
  
• CREDENTIAL_PROTOCOL Credential protocol name
  Name of the used credential protocol
  Simple Constraint: { SharePointSAML,AzureADUserLogin,AzureADCert,AzureADClientSecret,Login }
  
• USER_NAME User name (email adress) (optional)
  Email address of the SharePoint user
  
• COMMON_NAME AzureAD common name (optional)
  Common name of the AzureAD certificate
  
• IS_DIRECTORY Path is directory
  Specifies if the path that will be moved is a directory
  Simple Constraint: { true,false }
  Default: false
  
• FROM_PATH From path (server relative path)
  Source path (server relative path) of the file or directory that will be moved from
  
• TO_PATH To path (server relative path)
  Destination path (server relative path) of the file or directory that will be moved to
  
• OVERWRITE Overwrite existing file
  Should an existing file with the same name at the destination be overwritten, no effect if "Path is directory" parameter is set
  Simple Constraint: { true,false }
  Default: false
  
• CREATE_MISSING_DIRECTORIES Create missing destinations directories
  If true and the destination path does not yet exist, then all missing directories in the path will be created. Otherwise the move process will fail with an error.
  Simple Constraint: { true,false }
  Default: false
  
• OUT_URL URL of the destination file/directory (out)
  URL of the destination file/directory