# LifecycleApi

All URIs are relative to */api/v3*

| Method | HTTP request | Description |
|------------- | ------------- | -------------|
| [**lifecycleIterationsCreate**](LifecycleApi.md#lifecycleiterationscreate) | **POST** /lifecycle/iterations/ |  |
| [**lifecycleIterationsListLatest**](LifecycleApi.md#lifecycleiterationslistlatest) | **GET** /lifecycle/iterations/latest/{content_type}/{object_id}/ |  |
| [**lifecycleIterationsListOpen**](LifecycleApi.md#lifecycleiterationslistopen) | **GET** /lifecycle/iterations/open/ |  |
| [**lifecycleReviewsCreate**](LifecycleApi.md#lifecyclereviewscreate) | **POST** /lifecycle/reviews/ |  |
| [**lifecycleRulesCreate**](LifecycleApi.md#lifecyclerulescreate) | **POST** /lifecycle/rules/ |  |
| [**lifecycleRulesDestroy**](LifecycleApi.md#lifecyclerulesdestroy) | **DELETE** /lifecycle/rules/{id}/ |  |
| [**lifecycleRulesList**](LifecycleApi.md#lifecycleruleslist) | **GET** /lifecycle/rules/ |  |
| [**lifecycleRulesPartialUpdate**](LifecycleApi.md#lifecyclerulespartialupdate) | **PATCH** /lifecycle/rules/{id}/ |  |
| [**lifecycleRulesRetrieve**](LifecycleApi.md#lifecyclerulesretrieve) | **GET** /lifecycle/rules/{id}/ |  |
| [**lifecycleRulesUpdate**](LifecycleApi.md#lifecyclerulesupdate) | **PUT** /lifecycle/rules/{id}/ |  |
| [**lifecycleUserOffboardingCreate**](LifecycleApi.md#lifecycleuseroffboardingcreate) | **POST** /lifecycle/user_offboarding/ |  |
| [**lifecycleUserOffboardingDestroy**](LifecycleApi.md#lifecycleuseroffboardingdestroy) | **DELETE** /lifecycle/user_offboarding/{id}/ |  |
| [**lifecycleUserOffboardingList**](LifecycleApi.md#lifecycleuseroffboardinglist) | **GET** /lifecycle/user_offboarding/ |  |
| [**lifecycleUserOffboardingRetrieve**](LifecycleApi.md#lifecycleuseroffboardingretrieve) | **GET** /lifecycle/user_offboarding/{id}/ |  |



## lifecycleIterationsCreate

> LifecycleIteration lifecycleIterationsCreate(lifecycleIterationRequest)



Mixin to validate that a valid enterprise license exists before allowing to save the object

### Example

```ts
import {
  Configuration,
  LifecycleApi,
} from '@goauthentik/api';
import type { LifecycleIterationsCreateRequest } from '@goauthentik/api';

async function example() {
  console.log("🚀 Testing @goauthentik/api SDK...");
  const config = new Configuration({ 
    // Configure HTTP bearer authorization: authentik
    accessToken: "YOUR BEARER TOKEN",
  });
  const api = new LifecycleApi(config);

  const body = {
    // LifecycleIterationRequest
    lifecycleIterationRequest: ...,
  } satisfies LifecycleIterationsCreateRequest;

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

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

### Parameters


| Name | Type | Description  | Notes |
|------------- | ------------- | ------------- | -------------|
| **lifecycleIterationRequest** | [LifecycleIterationRequest](LifecycleIterationRequest.md) |  | |

### Return type

[**LifecycleIteration**](LifecycleIteration.md)

### Authorization

[authentik](../README.md#authentik)

### HTTP request headers

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


### HTTP response details
| Status code | Description | Response headers |
|-------------|-------------|------------------|
| **201** |  |  -  |
| **400** |  |  -  |
| **403** |  |  -  |

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


## lifecycleIterationsListLatest

> Array<LifecycleIteration> lifecycleIterationsListLatest(contentType, objectId, ordering, search, userIsReviewer)



Mixin to validate that a valid enterprise license exists before allowing to save the object

### Example

```ts
import {
  Configuration,
  LifecycleApi,
} from '@goauthentik/api';
import type { LifecycleIterationsListLatestRequest } from '@goauthentik/api';

async function example() {
  console.log("🚀 Testing @goauthentik/api SDK...");
  const config = new Configuration({ 
    // Configure HTTP bearer authorization: authentik
    accessToken: "YOUR BEARER TOKEN",
  });
  const api = new LifecycleApi(config);

  const body = {
    // string
    contentType: contentType_example,
    // string
    objectId: objectId_example,
    // string | Which field to use when ordering the results. (optional)
    ordering: ordering_example,
    // string | A search term. (optional)
    search: search_example,
    // boolean (optional)
    userIsReviewer: true,
  } satisfies LifecycleIterationsListLatestRequest;

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

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

### Parameters


| Name | Type | Description  | Notes |
|------------- | ------------- | ------------- | -------------|
| **contentType** | `string` |  | [Defaults to `undefined`] |
| **objectId** | `string` |  | [Defaults to `undefined`] |
| **ordering** | `string` | Which field to use when ordering the results. | [Optional] [Defaults to `undefined`] |
| **search** | `string` | A search term. | [Optional] [Defaults to `undefined`] |
| **userIsReviewer** | `boolean` |  | [Optional] [Defaults to `undefined`] |

### Return type

[**Array<LifecycleIteration>**](LifecycleIteration.md)

### Authorization

[authentik](../README.md#authentik)

### HTTP request headers

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


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

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


## lifecycleIterationsListOpen

> PaginatedLifecycleIterationList lifecycleIterationsListOpen(ordering, page, pageSize, search, userIsReviewer)



Mixin to validate that a valid enterprise license exists before allowing to save the object

### Example

```ts
import {
  Configuration,
  LifecycleApi,
} from '@goauthentik/api';
import type { LifecycleIterationsListOpenRequest } from '@goauthentik/api';

async function example() {
  console.log("🚀 Testing @goauthentik/api SDK...");
  const config = new Configuration({ 
    // Configure HTTP bearer authorization: authentik
    accessToken: "YOUR BEARER TOKEN",
  });
  const api = new LifecycleApi(config);

  const body = {
    // string | Which field to use when ordering the results. (optional)
    ordering: ordering_example,
    // number | A page number within the paginated result set. (optional)
    page: 56,
    // number | Number of results to return per page. (optional)
    pageSize: 56,
    // string | A search term. (optional)
    search: search_example,
    // boolean (optional)
    userIsReviewer: true,
  } satisfies LifecycleIterationsListOpenRequest;

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

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

### Parameters


| Name | Type | Description  | Notes |
|------------- | ------------- | ------------- | -------------|
| **ordering** | `string` | Which field to use when ordering the results. | [Optional] [Defaults to `undefined`] |
| **page** | `number` | A page number within the paginated result set. | [Optional] [Defaults to `undefined`] |
| **pageSize** | `number` | Number of results to return per page. | [Optional] [Defaults to `undefined`] |
| **search** | `string` | A search term. | [Optional] [Defaults to `undefined`] |
| **userIsReviewer** | `boolean` |  | [Optional] [Defaults to `undefined`] |

### Return type

[**PaginatedLifecycleIterationList**](PaginatedLifecycleIterationList.md)

### Authorization

[authentik](../README.md#authentik)

### HTTP request headers

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


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

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


## lifecycleReviewsCreate

> Review lifecycleReviewsCreate(reviewRequest)



Mixin to validate that a valid enterprise license exists before allowing to save the object

### Example

```ts
import {
  Configuration,
  LifecycleApi,
} from '@goauthentik/api';
import type { LifecycleReviewsCreateRequest } from '@goauthentik/api';

async function example() {
  console.log("🚀 Testing @goauthentik/api SDK...");
  const config = new Configuration({ 
    // Configure HTTP bearer authorization: authentik
    accessToken: "YOUR BEARER TOKEN",
  });
  const api = new LifecycleApi(config);

  const body = {
    // ReviewRequest
    reviewRequest: ...,
  } satisfies LifecycleReviewsCreateRequest;

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

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

### Parameters


| Name | Type | Description  | Notes |
|------------- | ------------- | ------------- | -------------|
| **reviewRequest** | [ReviewRequest](ReviewRequest.md) |  | |

### Return type

[**Review**](Review.md)

### Authorization

[authentik](../README.md#authentik)

### HTTP request headers

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


### HTTP response details
| Status code | Description | Response headers |
|-------------|-------------|------------------|
| **201** |  |  -  |
| **400** |  |  -  |
| **403** |  |  -  |

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


## lifecycleRulesCreate

> LifecycleRule lifecycleRulesCreate(lifecycleRuleRequest)



### Example

```ts
import {
  Configuration,
  LifecycleApi,
} from '@goauthentik/api';
import type { LifecycleRulesCreateRequest } from '@goauthentik/api';

async function example() {
  console.log("🚀 Testing @goauthentik/api SDK...");
  const config = new Configuration({ 
    // Configure HTTP bearer authorization: authentik
    accessToken: "YOUR BEARER TOKEN",
  });
  const api = new LifecycleApi(config);

  const body = {
    // LifecycleRuleRequest
    lifecycleRuleRequest: ...,
  } satisfies LifecycleRulesCreateRequest;

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

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

### Parameters


| Name | Type | Description  | Notes |
|------------- | ------------- | ------------- | -------------|
| **lifecycleRuleRequest** | [LifecycleRuleRequest](LifecycleRuleRequest.md) |  | |

### Return type

[**LifecycleRule**](LifecycleRule.md)

### Authorization

[authentik](../README.md#authentik)

### HTTP request headers

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


### HTTP response details
| Status code | Description | Response headers |
|-------------|-------------|------------------|
| **201** |  |  -  |
| **400** |  |  -  |
| **403** |  |  -  |

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


## lifecycleRulesDestroy

> lifecycleRulesDestroy(id)



### Example

```ts
import {
  Configuration,
  LifecycleApi,
} from '@goauthentik/api';
import type { LifecycleRulesDestroyRequest } from '@goauthentik/api';

async function example() {
  console.log("🚀 Testing @goauthentik/api SDK...");
  const config = new Configuration({ 
    // Configure HTTP bearer authorization: authentik
    accessToken: "YOUR BEARER TOKEN",
  });
  const api = new LifecycleApi(config);

  const body = {
    // string | A UUID string identifying this lifecycle rule.
    id: 38400000-8cf0-11bd-b23e-10b96e4ef00d,
  } satisfies LifecycleRulesDestroyRequest;

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

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

### Parameters


| Name | Type | Description  | Notes |
|------------- | ------------- | ------------- | -------------|
| **id** | `string` | A UUID string identifying this lifecycle rule. | [Defaults to `undefined`] |

### Return type

`void` (Empty response body)

### Authorization

[authentik](../README.md#authentik)

### HTTP request headers

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


### HTTP response details
| Status code | Description | Response headers |
|-------------|-------------|------------------|
| **204** | No response body |  -  |
| **400** |  |  -  |
| **403** |  |  -  |

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


## lifecycleRulesList

> PaginatedLifecycleRuleList lifecycleRulesList(contentTypeModel, ordering, page, pageSize, search)



### Example

```ts
import {
  Configuration,
  LifecycleApi,
} from '@goauthentik/api';
import type { LifecycleRulesListRequest } from '@goauthentik/api';

async function example() {
  console.log("🚀 Testing @goauthentik/api SDK...");
  const config = new Configuration({ 
    // Configure HTTP bearer authorization: authentik
    accessToken: "YOUR BEARER TOKEN",
  });
  const api = new LifecycleApi(config);

  const body = {
    // string (optional)
    contentTypeModel: contentTypeModel_example,
    // string | Which field to use when ordering the results. (optional)
    ordering: ordering_example,
    // number | A page number within the paginated result set. (optional)
    page: 56,
    // number | Number of results to return per page. (optional)
    pageSize: 56,
    // string | A search term. (optional)
    search: search_example,
  } satisfies LifecycleRulesListRequest;

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

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

### Parameters


| Name | Type | Description  | Notes |
|------------- | ------------- | ------------- | -------------|
| **contentTypeModel** | `string` |  | [Optional] [Defaults to `undefined`] |
| **ordering** | `string` | Which field to use when ordering the results. | [Optional] [Defaults to `undefined`] |
| **page** | `number` | A page number within the paginated result set. | [Optional] [Defaults to `undefined`] |
| **pageSize** | `number` | Number of results to return per page. | [Optional] [Defaults to `undefined`] |
| **search** | `string` | A search term. | [Optional] [Defaults to `undefined`] |

### Return type

[**PaginatedLifecycleRuleList**](PaginatedLifecycleRuleList.md)

### Authorization

[authentik](../README.md#authentik)

### HTTP request headers

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


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

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


## lifecycleRulesPartialUpdate

> LifecycleRule lifecycleRulesPartialUpdate(id, patchedLifecycleRuleRequest)



### Example

```ts
import {
  Configuration,
  LifecycleApi,
} from '@goauthentik/api';
import type { LifecycleRulesPartialUpdateRequest } from '@goauthentik/api';

async function example() {
  console.log("🚀 Testing @goauthentik/api SDK...");
  const config = new Configuration({ 
    // Configure HTTP bearer authorization: authentik
    accessToken: "YOUR BEARER TOKEN",
  });
  const api = new LifecycleApi(config);

  const body = {
    // string | A UUID string identifying this lifecycle rule.
    id: 38400000-8cf0-11bd-b23e-10b96e4ef00d,
    // PatchedLifecycleRuleRequest (optional)
    patchedLifecycleRuleRequest: ...,
  } satisfies LifecycleRulesPartialUpdateRequest;

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

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

### Parameters


| Name | Type | Description  | Notes |
|------------- | ------------- | ------------- | -------------|
| **id** | `string` | A UUID string identifying this lifecycle rule. | [Defaults to `undefined`] |
| **patchedLifecycleRuleRequest** | [PatchedLifecycleRuleRequest](PatchedLifecycleRuleRequest.md) |  | [Optional] |

### Return type

[**LifecycleRule**](LifecycleRule.md)

### Authorization

[authentik](../README.md#authentik)

### HTTP request headers

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


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

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


## lifecycleRulesRetrieve

> LifecycleRule lifecycleRulesRetrieve(id)



### Example

```ts
import {
  Configuration,
  LifecycleApi,
} from '@goauthentik/api';
import type { LifecycleRulesRetrieveRequest } from '@goauthentik/api';

async function example() {
  console.log("🚀 Testing @goauthentik/api SDK...");
  const config = new Configuration({ 
    // Configure HTTP bearer authorization: authentik
    accessToken: "YOUR BEARER TOKEN",
  });
  const api = new LifecycleApi(config);

  const body = {
    // string | A UUID string identifying this lifecycle rule.
    id: 38400000-8cf0-11bd-b23e-10b96e4ef00d,
  } satisfies LifecycleRulesRetrieveRequest;

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

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

### Parameters


| Name | Type | Description  | Notes |
|------------- | ------------- | ------------- | -------------|
| **id** | `string` | A UUID string identifying this lifecycle rule. | [Defaults to `undefined`] |

### Return type

[**LifecycleRule**](LifecycleRule.md)

### Authorization

[authentik](../README.md#authentik)

### HTTP request headers

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


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

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


## lifecycleRulesUpdate

> LifecycleRule lifecycleRulesUpdate(id, lifecycleRuleRequest)



### Example

```ts
import {
  Configuration,
  LifecycleApi,
} from '@goauthentik/api';
import type { LifecycleRulesUpdateRequest } from '@goauthentik/api';

async function example() {
  console.log("🚀 Testing @goauthentik/api SDK...");
  const config = new Configuration({ 
    // Configure HTTP bearer authorization: authentik
    accessToken: "YOUR BEARER TOKEN",
  });
  const api = new LifecycleApi(config);

  const body = {
    // string | A UUID string identifying this lifecycle rule.
    id: 38400000-8cf0-11bd-b23e-10b96e4ef00d,
    // LifecycleRuleRequest
    lifecycleRuleRequest: ...,
  } satisfies LifecycleRulesUpdateRequest;

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

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

### Parameters


| Name | Type | Description  | Notes |
|------------- | ------------- | ------------- | -------------|
| **id** | `string` | A UUID string identifying this lifecycle rule. | [Defaults to `undefined`] |
| **lifecycleRuleRequest** | [LifecycleRuleRequest](LifecycleRuleRequest.md) |  | |

### Return type

[**LifecycleRule**](LifecycleRule.md)

### Authorization

[authentik](../README.md#authentik)

### HTTP request headers

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


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

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


## lifecycleUserOffboardingCreate

> UserOffboarding lifecycleUserOffboardingCreate(userOffboardingRequest)



### Example

```ts
import {
  Configuration,
  LifecycleApi,
} from '@goauthentik/api';
import type { LifecycleUserOffboardingCreateRequest } from '@goauthentik/api';

async function example() {
  console.log("🚀 Testing @goauthentik/api SDK...");
  const config = new Configuration({ 
    // Configure HTTP bearer authorization: authentik
    accessToken: "YOUR BEARER TOKEN",
  });
  const api = new LifecycleApi(config);

  const body = {
    // UserOffboardingRequest
    userOffboardingRequest: ...,
  } satisfies LifecycleUserOffboardingCreateRequest;

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

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

### Parameters


| Name | Type | Description  | Notes |
|------------- | ------------- | ------------- | -------------|
| **userOffboardingRequest** | [UserOffboardingRequest](UserOffboardingRequest.md) |  | |

### Return type

[**UserOffboarding**](UserOffboarding.md)

### Authorization

[authentik](../README.md#authentik)

### HTTP request headers

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


### HTTP response details
| Status code | Description | Response headers |
|-------------|-------------|------------------|
| **201** |  |  -  |
| **400** |  |  -  |
| **403** |  |  -  |

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


## lifecycleUserOffboardingDestroy

> lifecycleUserOffboardingDestroy(id)



Cancel a pending offboarding instead of deleting the record.  The row is retained (as `CANCELED`) so the offboarding stays visible in the audit history; deletion would erase who scheduled and cancelled it. You cannot cancel an offboarding that targets you.

### Example

```ts
import {
  Configuration,
  LifecycleApi,
} from '@goauthentik/api';
import type { LifecycleUserOffboardingDestroyRequest } from '@goauthentik/api';

async function example() {
  console.log("🚀 Testing @goauthentik/api SDK...");
  const config = new Configuration({ 
    // Configure HTTP bearer authorization: authentik
    accessToken: "YOUR BEARER TOKEN",
  });
  const api = new LifecycleApi(config);

  const body = {
    // string | A UUID string identifying this User Offboarding.
    id: 38400000-8cf0-11bd-b23e-10b96e4ef00d,
  } satisfies LifecycleUserOffboardingDestroyRequest;

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

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

### Parameters


| Name | Type | Description  | Notes |
|------------- | ------------- | ------------- | -------------|
| **id** | `string` | A UUID string identifying this User Offboarding. | [Defaults to `undefined`] |

### Return type

`void` (Empty response body)

### Authorization

[authentik](../README.md#authentik)

### HTTP request headers

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


### HTTP response details
| Status code | Description | Response headers |
|-------------|-------------|------------------|
| **204** | No response body |  -  |
| **400** |  |  -  |
| **403** |  |  -  |

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


## lifecycleUserOffboardingList

> PaginatedUserOffboardingList lifecycleUserOffboardingList(action, ordering, page, pageSize, search, status, userUuid)



### Example

```ts
import {
  Configuration,
  LifecycleApi,
} from '@goauthentik/api';
import type { LifecycleUserOffboardingListRequest } from '@goauthentik/api';

async function example() {
  console.log("🚀 Testing @goauthentik/api SDK...");
  const config = new Configuration({ 
    // Configure HTTP bearer authorization: authentik
    accessToken: "YOUR BEARER TOKEN",
  });
  const api = new LifecycleApi(config);

  const body = {
    // OffboardingActionEnum (optional)
    action: ...,
    // string | Which field to use when ordering the results. (optional)
    ordering: ordering_example,
    // number | A page number within the paginated result set. (optional)
    page: 56,
    // number | Number of results to return per page. (optional)
    pageSize: 56,
    // string | A search term. (optional)
    search: search_example,
    // OffboardingStatusEnum (optional)
    status: ...,
    // string (optional)
    userUuid: 38400000-8cf0-11bd-b23e-10b96e4ef00d,
  } satisfies LifecycleUserOffboardingListRequest;

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

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

### Parameters


| Name | Type | Description  | Notes |
|------------- | ------------- | ------------- | -------------|
| **action** | `OffboardingActionEnum` |  | [Optional] [Defaults to `undefined`] [Enum: deactivate, delete] |
| **ordering** | `string` | Which field to use when ordering the results. | [Optional] [Defaults to `undefined`] |
| **page** | `number` | A page number within the paginated result set. | [Optional] [Defaults to `undefined`] |
| **pageSize** | `number` | Number of results to return per page. | [Optional] [Defaults to `undefined`] |
| **search** | `string` | A search term. | [Optional] [Defaults to `undefined`] |
| **status** | `OffboardingStatusEnum` |  | [Optional] [Defaults to `undefined`] [Enum: pending, completed, failed, canceled] |
| **userUuid** | `string` |  | [Optional] [Defaults to `undefined`] |

### Return type

[**PaginatedUserOffboardingList**](PaginatedUserOffboardingList.md)

### Authorization

[authentik](../README.md#authentik)

### HTTP request headers

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


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

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


## lifecycleUserOffboardingRetrieve

> UserOffboarding lifecycleUserOffboardingRetrieve(id)



### Example

```ts
import {
  Configuration,
  LifecycleApi,
} from '@goauthentik/api';
import type { LifecycleUserOffboardingRetrieveRequest } from '@goauthentik/api';

async function example() {
  console.log("🚀 Testing @goauthentik/api SDK...");
  const config = new Configuration({ 
    // Configure HTTP bearer authorization: authentik
    accessToken: "YOUR BEARER TOKEN",
  });
  const api = new LifecycleApi(config);

  const body = {
    // string | A UUID string identifying this User Offboarding.
    id: 38400000-8cf0-11bd-b23e-10b96e4ef00d,
  } satisfies LifecycleUserOffboardingRetrieveRequest;

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

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

### Parameters


| Name | Type | Description  | Notes |
|------------- | ------------- | ------------- | -------------|
| **id** | `string` | A UUID string identifying this User Offboarding. | [Defaults to `undefined`] |

### Return type

[**UserOffboarding**](UserOffboarding.md)

### Authorization

[authentik](../README.md#authentik)

### HTTP request headers

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


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

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