SPAdmin Control
Properties Methods Events Configuration Settings Errors
Manages sites, users, groups, and roles relating to a SharePoint Web Site.
Syntax
SPAdmin
Remarks
The SPAdmin control allows you to manage a SharePoint Web Site.
To get started, set the URL, User, and Password properties to point the control to your site.
When ListUsers, ListGroups, or ListRoles is called, events will be fired for each User, Group, and Role, respectively. The Users, Groups, and Roles properties will also be populated when each one is listed.
There are also methods to add, delete, or update the users, groups, and roles in SharePoint. To add and update, the Users, Groups, and Roles properties should be used to specify which users, groups, and roles to use in the call to SharePoint.
About SharePoint Online Services
When using Microsoft SharePoint Online you must set AuthScheme to authSPOnline (7).
Property List
The following is the full list of the properties of the control with short descriptions. Click on the links for further details.
| AuthScheme | The authentication scheme to be used while authenticating with the server. |
| FirewallAutoDetect | This property tells the component whether or not to automatically detect and use firewall system settings, if available. |
| FirewallType | This property determines the type of firewall to connect through. |
| FirewallHost | This property contains the name or IP address of firewall (optional). |
| FirewallPassword | This property contains a password if authentication is to be used when connecting through the firewall. |
| FirewallPort | This property contains the TCP port for the firewall Host . |
| FirewallUser | This property contains a user name if authentication is to be used connecting through a firewall. |
| GroupCount | The number of records in the Group arrays. |
| GroupDefaultLogin | The user name of the default user for the group. |
| GroupDescription | A description of the group. |
| GroupId | A unique Id for the group. |
| GroupName | The name of the group. |
| GroupNewName | The new name of the group. |
| GroupOwnerLogin | The user name of the owner of the group. |
| GroupOwnerType | The type of owner. |
| Idle | The current status of the component. |
| Password | The password to use for authentication. |
| ProxyAuthScheme | This property is used to tell the component which type of authorization to perform when connecting to the proxy. |
| ProxyAutoDetect | This property tells the component whether or not to automatically detect and use proxy system settings, if available. |
| ProxyPassword | This property contains a password if authentication is to be used for the proxy. |
| ProxyPort | This property contains the TCP port for the proxy Server (default 80). |
| ProxyServer | If a proxy Server is given, then the HTTP request is sent to the proxy instead of the server otherwise specified. |
| ProxySSL | This property determines when to use SSL for the connection to the proxy. |
| ProxyUser | This property contains a user name, if authentication is to be used for the proxy. |
| RoleCount | The number of records in the Role arrays. |
| RoleDescription | The description for the role. |
| RoleHidden | Whether or not the role is hidden. |
| RoleId | A unique Id for the role. |
| RoleName | The name of the role definition. |
| RoleNewName | The new name of the role definition. |
| RolePermissions | An integer representing the permissions for a new role definition. |
| RoleType | The type of role. |
| SiteDescription | The description of a site. |
| SiteOwnerEmail | The e-mail address of the owner of the site. |
| SiteOwnerLogin | The user name of the owner. |
| SiteOwnerName | The display name of the site owner. |
| SiteTitle | The display name of the site. |
| SiteURL | This is the absolute URL of the site collection. |
| SiteWebTemplate | The template to use for site creation. |
| SiteLevel | The site level. |
| SSLAcceptServerCertEncoded | The certificate (PEM/base64 encoded). |
| SSLCertEncoded | The certificate (PEM/base64 encoded). |
| SSLCertStore | The name of the certificate store for the client certificate. |
| SSLCertStorePassword | If the certificate store is of a type that requires a password, this property is used to specify that password in order to open the certificate store. |
| SSLCertStoreType | The type of certificate store for this certificate. |
| SSLCertSubject | The subject of the certificate used for client authentication. |
| SSLServerCertEncoded | The certificate (PEM/base64 encoded). |
| Timeout | A timeout for the component. |
| URL | The base URL for the site. |
| User | The user account to use for authentication. |
| UserCount | The number of records in the User arrays. |
| UserEmail | E-mail address of the user. |
| UserId | A unique Id for the user. |
| UserIsDomainGroup | Whether or not the user is in the domain group. |
| UserIsSiteAdmin | Whether or not the user is a site administrator. |
| UserLoginName | The user name of the user. |
| UserName | The display name of the user. |
| UserNotes | Notes for the user. |
| UserSecurityId | This is the security Id (SID) of the user. |
Method List
The following is the full list of the methods of the control with short descriptions. Click on the links for further details.
| AddGroups | Adds the specified groups to SharePoint. |
| AddGroupsToRole | Adds the specified groups to a role in SharePoint. |
| AddRoles | Adds the specified roles to SharePoint. |
| AddSite | Adds a site to SharePoint. |
| AddUsersToGroup | Adds the specified users to a group in SharePoint. |
| AddUsersToRole | Adds the specified users to a role in SharePoint. |
| Config | Sets or retrieves a configuration setting . |
| DeleteGroup | Delete the group. |
| DeleteGroupFromRole | Deletes the group. |
| DeleteRole | Delete the role. |
| DeleteSite | Deletes the specified site from SharePoint. |
| DeleteUser | Delete the user. |
| DeleteUserFromGroup | Remove the user from the specified group. |
| DeleteUserFromRole | Remove the user from the specified role. |
| DoEvents | Processes events from the internal message queue. |
| Interrupt | Interrupt the current method. |
| ListGroups | Lists the groups on the site. |
| ListGroupsOfUser | Lists the groups of the user. |
| ListRoles | Lists the roles on the site. |
| ListRolesOfUser | Lists the roles of the user. |
| ListUsers | Lists the users on the site. |
| Reset | Resets request-related properties. |
| UpdateGroups | Updates the specified groups in SharePoint. |
| UpdateRoles | Updates the specified roles in SharePoint. |
| UpdateUsers | Updates the specified users in SharePoint. |
Event List
The following is the full list of the events fired by the control with short descriptions. Click on the links for further details.
| Error | Information about errors during data delivery. |
| Group | Fired for each group. |
| Role | Fired for each role. |
| SSLServerAuthentication | Fired after the server presents its certificate to the client. |
| SSLStatus | Shows the progress of the secure connection. |
| User | Fired for each user. |
Configuration Settings
The following is a list of configuration settings for the control with short descriptions. Click on the links for further details.
| CustomWebTemplate | The custom web template. |
| SiteLocale | The locale identifier of the site. |
| UserGroup | The group from which to list users. |
| UserRole | The role from which to list users. |
| FormBasedCookies | Holds the security cookies for Form-Based Authentication. |
| SPOnlineSecurityCookies | Holds the security cookies for SharePoint Online. |
| SPOnlineSSO | Whether to use Single Sign On (SSO) with Active Directory Federation Services (ADFS). |
| SPOnlineSTS | The URL of the online STS. |
| SPOnlineADFSAuthScheme | The HTTP authentication scheme used when working with SSO. |
| SSODomain | Specifies the federation domain configured in Office 365. |
| AcceptEncoding | Used to tell the server which types of content encodings the client supports. |
| AllowHTTPCompression | This property enables HTTP compression for receiving data. |
| AllowIdenticalRedirectURL | Allow redirects to the same URL. |
| Append | Whether to append data to LocalFile. |
| Authorization | The Authorization string to be sent to the server. |
| BytesTransferred | Contains the number of bytes transferred in the response data. |
| EncodeURL | If set to true the URL will be encoded by the component. |
| FollowRedirects | Determines what happens when the server issues a redirect. |
| GetOn302Redirect | If set to true the component will perform a GET on the new location. |
| HTTPVersion | The version of HTTP used by the component. |
| IfModifiedSince | A date determining the maximum age of the desired document. |
| KeepAlive | Determines whether the HTTP connection is closed after completion of the request. |
| MaxRedirectAttempts | Limits the number of redirects that are followed in a request. |
| OtherHeaders | Other headers as determined by the user (optional). |
| ProxyAuthorization | The authorization string to be sent to the proxy server. |
| ProxyAuthScheme | The authorization scheme to be used for the proxy. |
| ProxyPassword | A password if authentication is to be used for the proxy. |
| ProxyPort | Port for the proxy server (default 80). |
| ProxyServer | Name or IP address of a proxy server (optional). |
| ProxyUser | A user name if authentication is to be used for the proxy. |
| TransferredDataLimit | The maximum number of incoming bytes to be stored by the component. |
| TransferredHeaders | The full set of headers as received from the server. |
| UseChunkedEncoding | Enables or Disables HTTP chunked encoding for transfers. |
| ChunkSize | Specifies the chunk size in bytes when using chunked encoding. |
| UserAgent | Information about the user agent (browser). |
| KerberosSPN | The Service Principal Name for the Kerberos Domain Controller. |
| ConnectionTimeout | Sets a separate timeout value for establishing a connection. |
| FirewallAutoDetect | Tells the component whether or not to automatically detect and use firewall system settings, if available. |
| FirewallHost | Name or IP address of firewall (optional). |
| FirewallPassword | Password to be used if authentication is to be used when connecting through the firewall. |
| FirewallPort | The TCP port for the FirewallHost;. |
| FirewallType | Determines the type of firewall to connect through. |
| FirewallUser | A user name if authentication is to be used connecting through a firewall. |
| KeepAliveTime | The inactivity time in milliseconds before a TCP keep-alive packet is sent. |
| KeepAliveInterval | The retry interval, in milliseconds, to be used when a TCP keep-alive packet is sent and no response is received. |
| Linger | When set to True, connections are terminated gracefully. |
| LingerTime | Time in seconds to have the connection linger. |
| LocalHost | The name of the local host through which connections are initiated or accepted. |
| LocalPort | The TCP port in the local host where the component binds. |
| MaxLineLength | The maximum amount of data to accumulate when no EOL is found. |
| MaxTransferRate | The transfer rate limit in bytes per second. |
| RecordLength | The length of received data records. |
| TCPKeepAlive | Determines whether or not the keep alive socket option is enabled. |
| UseIPv6 | Whether to use IPv6. |
| TcpNoDelay | Whether or not to delay when sending packets. |
| ReuseSSLSession | Determines if the SSL session is reused. |
| SSLCipherStrength | The minimum cipher strength used for bulk encryption. |
| SSLEnabledProtocols | Used to enable/disable the supported security protocols. |
| SSLProvider | The name of the security provider to use. |
| SSLSecurityFlags | Flags that control certificate verification. |
| OpenSSLCADir | The path to a directory containing CA certificates. |
| OpenSSLCAFile | Name of the file containing the list of CA's trusted by your application. |
| OpenSSLCipherList | A string that controls the ciphers to be used by SSL. |
| OpenSSLPrngSeedData | The data to seed the pseudo random number generator (PRNG). |
| AbsoluteTimeout | Determines whether timeouts are inactivity timeouts or absolute timeouts. |
| FirewallData | Used to send extra data to the firewall. |
| InBufferSize | The size in bytes of the incoming queue of the socket. |
| OutBufferSize | The size in bytes of the outgoing queue of the socket. |
| CodePage | The system code page used for Unicode to Multibyte translations. |