# EventsAccessApi

All URIs are relative to *https://admin-api.connected.dev*

|Method | HTTP request | Description|
|------------- | ------------- | -------------|
|[**addEventAccessUser**](#addeventaccessuser) | **POST** /events/{eventId}/access-users | Grant a user access to an event|
|[**getEventAccessUsers**](#geteventaccessusers) | **GET** /events/{eventId}/access-users | List an event\'s access users|
|[**removeEventAccessUser**](#removeeventaccessuser) | **DELETE** /events/{eventId}/access-users/{userId} | Revoke a user\'s private event access|

# **addEventAccessUser**
> SyncAccounts200Response addEventAccessUser(addEventAccessUserRequest)

Looks up an existing platform user by email and grants them admin access to manage a specific event, and requires update permission on events; fails if no user with that email exists.

### Example

```typescript
import {
    EventsAccessApi,
    Configuration,
    AddEventAccessUserRequest
} from '@connectedxm/admin-sdk';

const configuration = new Configuration();
const apiInstance = new EventsAccessApi(configuration);

let eventId: string; //The event identifier (default to undefined)
let addEventAccessUserRequest: AddEventAccessUserRequest; //

const { status, data } = await apiInstance.addEventAccessUser(
    eventId,
    addEventAccessUserRequest
);
```

### Parameters

|Name | Type | Description  | Notes|
|------------- | ------------- | ------------- | -------------|
| **addEventAccessUserRequest** | **AddEventAccessUserRequest**|  | |
| **eventId** | [**string**] | The event identifier | defaults to undefined|


### Return type

**SyncAccounts200Response**

### Authorization

[ApiKeyAuth](../README.md#ApiKeyAuth), [OrganizationId](../README.md#OrganizationId)

### HTTP request headers

 - **Content-Type**: application/json
 - **Accept**: application/json


### HTTP response details
| Status code | Description | Response headers |
|-------------|-------------|------------------|
|**200** | Successful response |  -  |

[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)

# **getEventAccessUsers**
> GetEventAccessUsers200Response getEventAccessUsers()

Returns a paginated list of users granted access to the given private or restricted event, searchable by keyword; requires read permission on events.

### Example

```typescript
import {
    EventsAccessApi,
    Configuration
} from '@connectedxm/admin-sdk';

const configuration = new Configuration();
const apiInstance = new EventsAccessApi(configuration);

let eventId: string; //The event identifier (default to undefined)
let page: number; //Page number (optional) (default to 1)
let pageSize: number; //Number of items per page (optional) (default to 25)
let orderBy: string; //Field to order by (optional) (default to undefined)
let search: string; //Search query (optional) (default to undefined)

const { status, data } = await apiInstance.getEventAccessUsers(
    eventId,
    page,
    pageSize,
    orderBy,
    search
);
```

### Parameters

|Name | Type | Description  | Notes|
|------------- | ------------- | ------------- | -------------|
| **eventId** | [**string**] | The event identifier | defaults to undefined|
| **page** | [**number**] | Page number | (optional) defaults to 1|
| **pageSize** | [**number**] | Number of items per page | (optional) defaults to 25|
| **orderBy** | [**string**] | Field to order by | (optional) defaults to undefined|
| **search** | [**string**] | Search query | (optional) defaults to undefined|


### Return type

**GetEventAccessUsers200Response**

### Authorization

[ApiKeyAuth](../README.md#ApiKeyAuth), [OrganizationId](../README.md#OrganizationId)

### HTTP request headers

 - **Content-Type**: Not defined
 - **Accept**: application/json


### HTTP response details
| Status code | Description | Response headers |
|-------------|-------------|------------------|
|**200** | Successful response |  -  |

[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)

# **removeEventAccessUser**
> SyncAccounts200Response removeEventAccessUser()

Removes a user from the list of users explicitly granted access to a private event, revoking their ability to view or purchase it; requires update permission on events.

### Example

```typescript
import {
    EventsAccessApi,
    Configuration
} from '@connectedxm/admin-sdk';

const configuration = new Configuration();
const apiInstance = new EventsAccessApi(configuration);

let eventId: string; //The event identifier (default to undefined)
let userId: string; //The user identifier (default to undefined)

const { status, data } = await apiInstance.removeEventAccessUser(
    eventId,
    userId
);
```

### Parameters

|Name | Type | Description  | Notes|
|------------- | ------------- | ------------- | -------------|
| **eventId** | [**string**] | The event identifier | defaults to undefined|
| **userId** | [**string**] | The user identifier | defaults to undefined|


### Return type

**SyncAccounts200Response**

### Authorization

[ApiKeyAuth](../README.md#ApiKeyAuth), [OrganizationId](../README.md#OrganizationId)

### HTTP request headers

 - **Content-Type**: Not defined
 - **Accept**: application/json


### HTTP response details
| Status code | Description | Response headers |
|-------------|-------------|------------------|
|**200** | Successful response |  -  |

[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)