# UsersApi

All URIs are relative to *http://localhost*

| Method | HTTP request | Description |
|------------- | ------------- | -------------|
| [**createUser**](UsersApi.md#createuser) | **POST** /fna/api/v2/organizations/{uuid}/users |  |
| [**deleteUser**](UsersApi.md#deleteuser) | **DELETE** /fna/api/v2/users/{uuid} |  |
| [**getUser**](UsersApi.md#getuser) | **GET** /fna/api/v2/users/{uuid} |  |
| [**getUserContext**](UsersApi.md#getusercontext) | **GET** /fna/api/v2/userContext |  |
| [**transferUserData**](UsersApi.md#transferuserdata) | **POST** /fna/api/v2/users/{uuid}/transfer-data |  |



## createUser

> UserCreateUserResponse createUser(uuid, userCreateUserPayload)



### Example

```ts
import {
  Configuration,
  UsersApi,
} from '@equisoft/equisoft-plan-sdk-typescript';
import type { CreateUserRequest } from '@equisoft/equisoft-plan-sdk-typescript';

async function example() {
  console.log("🚀 Testing @equisoft/equisoft-plan-sdk-typescript SDK...");
  const config = new Configuration({ 
    // To configure OAuth2 access token for authorization: OAuth2 implicit
    accessToken: "YOUR ACCESS TOKEN",
  });
  const api = new UsersApi(config);

  const body = {
    // string
    uuid: uuid_example,
    // UserCreateUserPayload | User creation payload
    userCreateUserPayload: ...,
  } satisfies CreateUserRequest;

  try {
    const data = await api.createUser(body);
    console.log(data);
  } catch (error) {
    console.error(error);
  }
}

// Run the test
example().catch(console.error);
```

### Parameters


| Name | Type | Description  | Notes |
|------------- | ------------- | ------------- | -------------|
| **uuid** | `string` |  | [Defaults to `undefined`] |
| **userCreateUserPayload** | [UserCreateUserPayload](UserCreateUserPayload.md) | User creation payload | |

### Return type

[**UserCreateUserResponse**](UserCreateUserResponse.md)

### Authorization

[OAuth2 implicit](../README.md#OAuth2-implicit)

### HTTP request headers

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


### HTTP response details
| Status code | Description | Response headers |
|-------------|-------------|------------------|
| **200** | Success |  -  |
| **401** | Access denied |  -  |
| **500** | Server error |  -  |

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


## deleteUser

> deleteUser(uuid)



### Example

```ts
import {
  Configuration,
  UsersApi,
} from '@equisoft/equisoft-plan-sdk-typescript';
import type { DeleteUserRequest } from '@equisoft/equisoft-plan-sdk-typescript';

async function example() {
  console.log("🚀 Testing @equisoft/equisoft-plan-sdk-typescript SDK...");
  const config = new Configuration({ 
    // To configure OAuth2 access token for authorization: OAuth2 implicit
    accessToken: "YOUR ACCESS TOKEN",
  });
  const api = new UsersApi(config);

  const body = {
    // string
    uuid: uuid_example,
  } satisfies DeleteUserRequest;

  try {
    const data = await api.deleteUser(body);
    console.log(data);
  } catch (error) {
    console.error(error);
  }
}

// Run the test
example().catch(console.error);
```

### Parameters


| Name | Type | Description  | Notes |
|------------- | ------------- | ------------- | -------------|
| **uuid** | `string` |  | [Defaults to `undefined`] |

### Return type

`void` (Empty response body)

### Authorization

[OAuth2 implicit](../README.md#OAuth2-implicit)

### HTTP request headers

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


### HTTP response details
| Status code | Description | Response headers |
|-------------|-------------|------------------|
| **204** | User successfully deleted |  -  |
| **401** | Access denied |  -  |
| **404** | User not found |  -  |
| **500** | Server error |  -  |

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


## getUser

> UsersUser getUser(uuid)



### Example

```ts
import {
  Configuration,
  UsersApi,
} from '@equisoft/equisoft-plan-sdk-typescript';
import type { GetUserRequest } from '@equisoft/equisoft-plan-sdk-typescript';

async function example() {
  console.log("🚀 Testing @equisoft/equisoft-plan-sdk-typescript SDK...");
  const config = new Configuration({ 
    // To configure OAuth2 access token for authorization: OAuth2 implicit
    accessToken: "YOUR ACCESS TOKEN",
  });
  const api = new UsersApi(config);

  const body = {
    // string
    uuid: uuid_example,
  } satisfies GetUserRequest;

  try {
    const data = await api.getUser(body);
    console.log(data);
  } catch (error) {
    console.error(error);
  }
}

// Run the test
example().catch(console.error);
```

### Parameters


| Name | Type | Description  | Notes |
|------------- | ------------- | ------------- | -------------|
| **uuid** | `string` |  | [Defaults to `undefined`] |

### Return type

[**UsersUser**](UsersUser.md)

### Authorization

[OAuth2 implicit](../README.md#OAuth2-implicit)

### HTTP request headers

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


### HTTP response details
| Status code | Description | Response headers |
|-------------|-------------|------------------|
| **200** | Success |  -  |
| **401** | Access denied |  -  |
| **404** | Not found |  -  |
| **500** | Server error |  -  |

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


## getUserContext

> UsersUserContext getUserContext()



### Example

```ts
import {
  Configuration,
  UsersApi,
} from '@equisoft/equisoft-plan-sdk-typescript';
import type { GetUserContextRequest } from '@equisoft/equisoft-plan-sdk-typescript';

async function example() {
  console.log("🚀 Testing @equisoft/equisoft-plan-sdk-typescript SDK...");
  const config = new Configuration({ 
    // To configure OAuth2 access token for authorization: OAuth2 implicit
    accessToken: "YOUR ACCESS TOKEN",
  });
  const api = new UsersApi(config);

  try {
    const data = await api.getUserContext();
    console.log(data);
  } catch (error) {
    console.error(error);
  }
}

// Run the test
example().catch(console.error);
```

### Parameters

This endpoint does not need any parameter.

### Return type

[**UsersUserContext**](UsersUserContext.md)

### Authorization

[OAuth2 implicit](../README.md#OAuth2-implicit)

### HTTP request headers

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


### HTTP response details
| Status code | Description | Response headers |
|-------------|-------------|------------------|
| **200** | Success |  -  |
| **401** | Access denied |  -  |
| **404** | Not found |  -  |
| **500** | Server error |  -  |

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


## transferUserData

> transferUserData(uuid, userTransferDataPayload)



### Example

```ts
import {
  Configuration,
  UsersApi,
} from '@equisoft/equisoft-plan-sdk-typescript';
import type { TransferUserDataRequest } from '@equisoft/equisoft-plan-sdk-typescript';

async function example() {
  console.log("🚀 Testing @equisoft/equisoft-plan-sdk-typescript SDK...");
  const config = new Configuration({ 
    // To configure OAuth2 access token for authorization: OAuth2 implicit
    accessToken: "YOUR ACCESS TOKEN",
  });
  const api = new UsersApi(config);

  const body = {
    // string | UUID of the source user account
    uuid: 38400000-8cf0-11bd-b23e-10b96e4ef00d,
    // UserTransferDataPayload | User data transfer payload
    userTransferDataPayload: ...,
  } satisfies TransferUserDataRequest;

  try {
    const data = await api.transferUserData(body);
    console.log(data);
  } catch (error) {
    console.error(error);
  }
}

// Run the test
example().catch(console.error);
```

### Parameters


| Name | Type | Description  | Notes |
|------------- | ------------- | ------------- | -------------|
| **uuid** | `string` | UUID of the source user account | [Defaults to `undefined`] |
| **userTransferDataPayload** | [UserTransferDataPayload](UserTransferDataPayload.md) | User data transfer payload | |

### Return type

`void` (Empty response body)

### Authorization

[OAuth2 implicit](../README.md#OAuth2-implicit)

### HTTP request headers

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


### HTTP response details
| Status code | Description | Response headers |
|-------------|-------------|------------------|
| **204** | Data successfully transferred |  -  |
| **401** | Access denied |  -  |
| **404** | User not found |  -  |
| **409** | Conflict - users are in different organizations or are client access users |  -  |
| **422** | Invalid request - client access user cannot be source or target |  -  |
| **500** | Server error |  -  |

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