---
title: "SharePoint Adapter Actions"
slug: "sharepoint-adapter-actions"
description: "This is a list of actions that can be taken in RapidIdentity Connect to interact with the SharePoint Adapter and its resulting data."
tags: ["RapidIdentity ", "Connect", "Adapter", "Actions", "SharePoint"]
updated: 2022-06-03T19:56:24Z
published: 2022-06-03T19:56:24Z
canonical: "help.rapididentity.com/sharepoint-adapter-actions"
---

> ## Documentation Index
> Fetch the complete documentation index at: https://help.rapididentity.com/llms.txt
> Use this file to discover all available pages before exploring further.

# SharePoint Adapter Actions

## SharePoint Adapter Actions

### addSharePointGroupMember

Add a member to a SharePoint Group

| Property | Value | Description |
| --- | --- | --- |
| connection* | expression, variable | the SharePoint connection definition |
| groupName* | text, expression, variable | the name of the Group |
| userLoginName* | text, expression, variable | the login name of the User to add to the Group |
| returnVariable | expression, variable | name of the variable to be assigned to the return value |

```actionscript
memberAdded = addSharePointGroupMember(session,
"testGroup", "Test\\\\testuser")
```

### defineSharePointConnection

Define a connection to SharePoint.

| Property | Value | Description |
| --- | --- | --- |
| siteUrl* | text, expression, variable | URL of the SharePoint site |
| username | text, expression, variable | username for authentication to SharePoint |
| password | password, string, expression, variable | password for authentication to SharePoint |
| options | expression, variable | A record or JavaScript object with a field for each additional option. Currently defined fields are connectTimeout and socketTime which require a numeric value from 1 to 2147483647 (0x7FFFFFFF) that represents the number of milliseconds for the timeout, and 0 representing no timeout. |
| returnVariable | expression, variable | name of the variable to be assigned to the return value |

```actionscript
Global.spHost = "sharepoint.test.local"
Global.spUser = "Test\\\\Administrator"
Global.spPwd = <Password>
session = defineSharePointConnection("http://" + Global.spHost,
Global.spUser,<Password>)
```

### deleteSharePointGroup

Delete a SharePoint Group record.

| Property | Value | Description |
| --- | --- | --- |
| connection* | expression, variable | the SharePoint connection definition |
| groupName* | text, expression, variable | the name of the SharePoint Group to delete |
| returnVariable | expression, variable | name of the variable to be assigned to the return value |

```actionscript
deleted = deleteSharePointGroup(session, "testGroup")
```

### deleteSharePointGroupMember

Delete a member from a SharePoint Group.

| Property | Value | Description |
| --- | --- | --- |
| connection* | expression, variable | the SharePoint connection definition |
| groupName* | text, expression, variable | the id of the group |
| userLoginName* | text, expression, variable | the id of the object to delete from the Group |
| returnVariable | expression, variable | name of the variable to be assigned to the return value |

```actionscript
memberDeleted = deleteSharePointGroupMember(session, "testGroup",
"Test\\\\testuser")
```

### getSharePointGroup

Get a SharePoint Group record.

| Property | Value | Description |
| --- | --- | --- |
| connection* | expression, variable | the SharePoint connection definition |
| groupName* | text, expression, variable | the name of the SharePoint Group to get |
| returnVariable | expression, variable | name of the variable to be assigned to the return value |

```actionscript
group = getSharePointGroup(session, "testGroup")
```

### getSharePointGroups

Get SharePoint Group records.

| Property | Value | Description |
| --- | --- | --- |
| connection* | expression, variable | the SharePoint connection definition |
| returnVariable | expression, variable | name of the variable to be assigned to the return value |

```actionscript
groups = getSharePointGroups(session)
```

### getSharePointUser

Get a SharePoint User record.

| Property | Value | Description |
| --- | --- | --- |
| connection* | expression, variable | the SharePoint connection definition |
| loginName* | text, expression, variable | the loginName of the SharePoint User to get |
| returnVariable | expression, variable | name of the variable to be assigned to the return value |

```actionscript
user = getSharePointUser(session, "Test\\\\testuser")
```

### getSharePointUsers

Get SharePoint User records.

| Property | Value | Description |
| --- | --- | --- |
| connection* | expression, variable | the SharePoint connection definition |
| returnVariable | expression, variable | name of the variable to be assigned to the return value |

```actionscript
users = getSharePointUsers(session)
```

### renameSharePointGroup

Rename a SharePoint Group record.

| Property | Value | Description |
| --- | --- | --- |
| connection* | expression, variable | the SharePoint connection definition |
| groupName* | text, expression, variable | the name of the SharePoint Group to rename |
| newName* | text, expression, variable | the new name |
| returnVariable | expression, variable | name of the variable to be assigned to the return value |

```actionscript
renamed = renameSharePointGroup(session, "testGroup", "testGroup1")
```

### saveSharePointGroup

Create/Update a SharePoint Group record.

| Property | Value | Description |
| --- | --- | --- |
| connection* | expression, variable | the SharePoint connection definition |
| record* | expression, variable | the record to save |
| returnVariable | expression, variable | name of the variable to be assigned to the return value |

```actionscript
groupTemplate = createRecord()
setRecordField(groupTemplate, "Name", "testGroup")
created = saveSharePointGroup(session, groupTemplate)
```

### saveSharePointUser

Create/Update a SharePoint User record.

| Property | Value | Description |
| --- | --- | --- |
| connection* | expression, variable | the SharePoint connection definition |
| record* | expression, variable | the record to save |
| returnVariable | expression, variable | name of the variable to be assigned to the return value |

```actionscript
userTemplate = createRecord()
setRecordField(userTemplate, "LoginName", "Test\\\\testUser")
setRecordField(userTemplate, "Name", "testUser")
created = saveSharePointUser(session, userTemplate)
```

### Supported SharePoint User Record Fields

| Field | Read-Only | Description |
| --- | --- | --- |
| LoginName (required) | Y | User login name (from the Authentication Provider, usually AD - must exist in the provider before can be created in SharePoint) |
| Name | N | Display Name |
| Email | N | User e-mail address |
| Notes | N | Descriptive notes about User |
| Groups | Y | List of Groups that the User is a member of |
| ID | Y | Internal SharePoint ID |
| IsDomainGroup | Y | Domain group flag |
| IsSiteAdmin | Y | Site administrator flag |
| SID | Y | Security ID |

### Supported SharePoint Group Record Fields

| Field | Read-Only | Description |
| --- | --- | --- |
| Name (required) | Y | Name of Group |
| Description | N | Description of Group |
| OwnerIdentifier | N | Name of Group or LoginName of User that owns this group |
| OwnerType | N | The type of the OwnerIdentitifier: “user” or “group” |
| Users | Y | List of Users that are members of Group |
| ID | Y | Internal SharePoint ID |
| OwnerID | Y | Internal SharePoint ID of Owner |
| OwnerIsUser | Y | Owner type flag flag |