Cmdlets for Microsoft SharePoint

Build 24.0.8963

Users

Updates, deletes, and queries Users from SharePoint.

Table Specific Information

Select

Retrieves all users created for the SharePoint Account:

SELECT * FROM Users

You can retrieve Users that belong to a specific Group. In this case specify the Group Name:

SELECT * FROM Users WHERE [Group] = "GroupName"

Or you can retrieve Users that have a specific Role. In this case specify the Role Name:

SELECT * FROM Users WHERE [Role] = "RoleName"

Columns

Name Type ReadOnly Description
ID String True

The Id of the user.

LoginName# [KEY] String False

The login name of the user.

Name# String False

The name of the user.

Email# String False

The email address of the user.

IsInDomainGroup Boolean True

A boolean indicating if the user is in the domain group.

IsSiteAdmin Boolean True

A boolean indicating if the user is a site admin.

Notes# String False

Optional notes concerning the user.

SecurityId String True

The security Id (SID) for the user.

Pseudo-Columns

Pseudo column fields are used in the WHERE clause of SELECT statements and offer a more granular control over the tuples that are returned from the data source.

Name Type Description
Group String

The group you are adding a user to and selecting or deleting the user from. This is an input-only value and you must specify either Group or Role for inserts and selects, but you can optionally specify deletions.

Role String

The role you are adding a user to and selecting or deleting the user from. This is an input-only value and you must specify either Group or Role for inserts and selects, but but you can optionally specify deletions.

Copyright (c) 2024 CData Software, Inc. - All rights reserved.
Build 24.0.8963