@ory/client
Version:
OpenAPI client for @ory/client
1,240 lines (839 loc) • 40.3 kB
Markdown
All URIs are relative to *https://playground.projects.oryapis.com*
|Method | HTTP request | Description|
|------------- | ------------- | -------------|
|[**createOrganization**](
|[**createOrganizationOnboardingPortalLink**](
|[**createProject**](
|[**createProjectApiKey**](
|[**deleteOrganization**](
|[**deleteOrganizationOnboardingPortalLink**](
|[**deleteProjectApiKey**](
|[**getOrganization**](
|[**getOrganizationOnboardingPortalLinks**](
|[**getProject**](
|[**getProjectMembers**](
|[**listOrganizations**](
|[**listProjectApiKeys**](
|[**listProjects**](
|[**patchProject**](
|[**patchProjectWithRevision**](
|[**purgeProject**](
|[**removeProjectMember**](
|[**setProject**](
|[**updateOrganization**](
|[**updateOrganizationOnboardingPortalLink**](
> Organization createOrganization()
Deprecated: use setProject or patchProjectWithRevision instead Creates an Enterprise SSO Organization in a project.
### Example
```typescript
import {
ProjectApi,
Configuration,
OrganizationBody
} from '@ory/client';
const configuration = new Configuration();
const apiInstance = new ProjectApi(configuration);
let projectId: string; //Project ID The project\'s ID. (default to undefined)
let organizationBody: OrganizationBody; // (optional)
const { status, data } = await apiInstance.createOrganization(
projectId,
organizationBody
);
```
|Name | Type | Description | Notes|
|------------- | ------------- | ------------- | -------------|
| **organizationBody** | **OrganizationBody**| | |
| **projectId** | [**string**] | Project ID The project\&
**Organization**
[](../README.md
- **Content-Type**: application/json
- **Accept**: application/json
| Status code | Description | Response headers |
|-------------|-------------|------------------|
|**201** | organization | - |
|**400** | errorGeneric | - |
|**403** | errorGeneric | - |
|**409** | errorGeneric | - |
|**0** | errorGeneric | - |
[[Back to top]](
> OnboardingPortalLink createOrganizationOnboardingPortalLink()
Create a onboarding portal link for an organization.
### Example
```typescript
import {
ProjectApi,
Configuration,
CreateOrganizationOnboardingPortalLinkBody
} from '@ory/client';
const configuration = new Configuration();
const apiInstance = new ProjectApi(configuration);
let projectId: string; //Project ID The project\'s ID. (default to undefined)
let organizationId: string; //Organization ID The Organization\'s ID. (default to undefined)
let createOrganizationOnboardingPortalLinkBody: CreateOrganizationOnboardingPortalLinkBody; // (optional)
const { status, data } = await apiInstance.createOrganizationOnboardingPortalLink(
projectId,
organizationId,
createOrganizationOnboardingPortalLinkBody
);
```
|Name | Type | Description | Notes|
|------------- | ------------- | ------------- | -------------|
| **createOrganizationOnboardingPortalLinkBody** | **CreateOrganizationOnboardingPortalLinkBody**| | |
| **projectId** | [**string**] | Project ID The project\&
| **organizationId** | [**string**] | Organization ID The Organization\&
**OnboardingPortalLink**
[](../README.md
- **Content-Type**: application/json
- **Accept**: application/json
| Status code | Description | Response headers |
|-------------|-------------|------------------|
|**201** | onboardingPortalLink | - |
|**0** | errorGeneric | - |
[[Back to top]](
> Project createProject()
Creates a new project.
### Example
```typescript
import {
ProjectApi,
Configuration,
CreateProjectBody
} from '@ory/client';
const configuration = new Configuration();
const apiInstance = new ProjectApi(configuration);
let createProjectBody: CreateProjectBody; // (optional)
const { status, data } = await apiInstance.createProject(
createProjectBody
);
```
|Name | Type | Description | Notes|
|------------- | ------------- | ------------- | -------------|
| **createProjectBody** | **CreateProjectBody**| | |
**Project**
[](../README.md
- **Content-Type**: application/json
- **Accept**: application/json
| Status code | Description | Response headers |
|-------------|-------------|------------------|
|**201** | project | - |
|**400** | errorGeneric | - |
|**401** | errorGeneric | - |
|**403** | errorGeneric | - |
|**404** | errorGeneric | - |
|**0** | errorGeneric | - |
[[Back to top]](
> ProjectApiKey createProjectApiKey()
Create an API key for a project.
### Example
```typescript
import {
ProjectApi,
Configuration,
CreateProjectApiKeyRequest
} from '@ory/client';
const configuration = new Configuration();
const apiInstance = new ProjectApi(configuration);
let project: string; //The Project ID or Project slug (default to undefined)
let createProjectApiKeyRequest: CreateProjectApiKeyRequest; // (optional)
const { status, data } = await apiInstance.createProjectApiKey(
project,
createProjectApiKeyRequest
);
```
|Name | Type | Description | Notes|
|------------- | ------------- | ------------- | -------------|
| **createProjectApiKeyRequest** | **CreateProjectApiKeyRequest**| | |
| **project** | [**string**] | The Project ID or Project slug | defaults to undefined|
**ProjectApiKey**
[](../README.md
- **Content-Type**: application/json
- **Accept**: application/json
| Status code | Description | Response headers |
|-------------|-------------|------------------|
|**201** | projectApiKey | - |
|**0** | errorGeneric | - |
[[Back to top]](
> deleteOrganization()
Deprecated: use setProject or patchProjectWithRevision instead Irrecoverably deletes an Enterprise SSO Organization in a project by its ID.
```typescript
import {
ProjectApi,
Configuration
} from '@ory/client';
const configuration = new Configuration();
const apiInstance = new ProjectApi(configuration);
let projectId: string; //Project ID The project\'s ID. (default to undefined)
let organizationId: string; //Organization ID The Organization\'s ID. (default to undefined)
const { status, data } = await apiInstance.deleteOrganization(
projectId,
organizationId
);
```
|Name | Type | Description | Notes|
|------------- | ------------- | ------------- | -------------|
| **projectId** | [**string**] | Project ID The project\&
| **organizationId** | [**string**] | Organization ID The Organization\&
void (empty response body)
[](../README.md
- **Content-Type**: Not defined
- **Accept**: application/json
| Status code | Description | Response headers |
|-------------|-------------|------------------|
|**204** | Empty responses are sent when, for example, resources are deleted. The HTTP status code for empty responses is typically 201. | - |
|**400** | errorGeneric | - |
|**403** | errorGeneric | - |
|**404** | errorGeneric | - |
|**409** | errorGeneric | - |
|**0** | errorGeneric | - |
[[Back to top]](
> deleteOrganizationOnboardingPortalLink()
Deletes a onboarding portal link for an organization.
```typescript
import {
ProjectApi,
Configuration
} from '@ory/client';
const configuration = new Configuration();
const apiInstance = new ProjectApi(configuration);
let projectId: string; // (default to undefined)
let organizationId: string; // (default to undefined)
let onboardingPortalLinkId: string; // (default to undefined)
const { status, data } = await apiInstance.deleteOrganizationOnboardingPortalLink(
projectId,
organizationId,
onboardingPortalLinkId
);
```
|Name | Type | Description | Notes|
|------------- | ------------- | ------------- | -------------|
| **projectId** | [**string**] | | defaults to undefined|
| **organizationId** | [**string**] | | defaults to undefined|
| **onboardingPortalLinkId** | [**string**] | | defaults to undefined|
void (empty response body)
[](../README.md
- **Content-Type**: Not defined
- **Accept**: application/json
| Status code | Description | Response headers |
|-------------|-------------|------------------|
|**204** | Empty responses are sent when, for example, resources are deleted. The HTTP status code for empty responses is typically 201. | - |
|**400** | errorGeneric | - |
|**403** | errorGeneric | - |
|**0** | errorGeneric | - |
[[Back to top]](
> deleteProjectApiKey()
Deletes an API key and immediately removes it.
```typescript
import {
ProjectApi,
Configuration
} from '@ory/client';
const configuration = new Configuration();
const apiInstance = new ProjectApi(configuration);
let project: string; //The Project ID or Project slug (default to undefined)
let tokenId: string; //The Token ID (default to undefined)
const { status, data } = await apiInstance.deleteProjectApiKey(
project,
tokenId
);
```
|Name | Type | Description | Notes|
|------------- | ------------- | ------------- | -------------|
| **project** | [**string**] | The Project ID or Project slug | defaults to undefined|
| **tokenId** | [**string**] | The Token ID | defaults to undefined|
void (empty response body)
[](../README.md
- **Content-Type**: Not defined
- **Accept**: application/json
| Status code | Description | Response headers |
|-------------|-------------|------------------|
|**204** | Empty responses are sent when, for example, resources are deleted. The HTTP status code for empty responses is typically 201. | - |
|**0** | errorGeneric | - |
[[Back to top]](
> GetOrganizationResponse getOrganization()
Deprecated: use getProject instead Retrieves an Enterprise SSO Organization for a project by its ID
### Example
```typescript
import {
ProjectApi,
Configuration
} from '@ory/client';
const configuration = new Configuration();
const apiInstance = new ProjectApi(configuration);
let projectId: string; //Project ID The project\'s ID. (default to undefined)
let organizationId: string; //Organization ID The Organization\'s ID. (default to undefined)
const { status, data } = await apiInstance.getOrganization(
projectId,
organizationId
);
```
|Name | Type | Description | Notes|
|------------- | ------------- | ------------- | -------------|
| **projectId** | [**string**] | Project ID The project\&
| **organizationId** | [**string**] | Organization ID The Organization\&
**GetOrganizationResponse**
[](../README.md
- **Content-Type**: Not defined
- **Accept**: application/json
| Status code | Description | Response headers |
|-------------|-------------|------------------|
|**200** | getOrganizationResponse | - |
|**400** | errorGeneric | - |
|**403** | errorGeneric | - |
|**404** | errorGeneric | - |
|**0** | errorGeneric | - |
[[Back to top]](
> OrganizationOnboardingPortalLinksResponse getOrganizationOnboardingPortalLinks()
Retrieves the organization onboarding portal links.
### Example
```typescript
import {
ProjectApi,
Configuration
} from '@ory/client';
const configuration = new Configuration();
const apiInstance = new ProjectApi(configuration);
let projectId: string; //Project ID The project\'s ID. (default to undefined)
let organizationId: string; //Organization ID The Organization\'s ID. (default to undefined)
const { status, data } = await apiInstance.getOrganizationOnboardingPortalLinks(
projectId,
organizationId
);
```
|Name | Type | Description | Notes|
|------------- | ------------- | ------------- | -------------|
| **projectId** | [**string**] | Project ID The project\&
| **organizationId** | [**string**] | Organization ID The Organization\&
**OrganizationOnboardingPortalLinksResponse**
[](../README.md
- **Content-Type**: Not defined
- **Accept**: application/json
| Status code | Description | Response headers |
|-------------|-------------|------------------|
|**200** | organizationOnboardingPortalLinksResponse | - |
|**400** | errorGeneric | - |
|**403** | errorGeneric | - |
|**0** | errorGeneric | - |
[[Back to top]](
> Project getProject()
Get a project you have access to by its ID.
### Example
```typescript
import {
ProjectApi,
Configuration
} from '@ory/client';
const configuration = new Configuration();
const apiInstance = new ProjectApi(configuration);
let projectId: string; //Project ID The project\'s ID. (default to undefined)
const { status, data } = await apiInstance.getProject(
projectId
);
```
|Name | Type | Description | Notes|
|------------- | ------------- | ------------- | -------------|
| **projectId** | [**string**] | Project ID The project\&
**Project**
[](../README.md
- **Content-Type**: Not defined
- **Accept**: application/json
| Status code | Description | Response headers |
|-------------|-------------|------------------|
|**200** | project | - |
|**401** | errorGeneric | - |
|**403** | errorGeneric | - |
|**404** | errorGeneric | - |
|**0** | errorGeneric | - |
[[Back to top]](
> Array<ProjectMember> getProjectMembers()
This endpoint requires the user to be a member of the project with the role `OWNER` or `DEVELOPER`.
### Example
```typescript
import {
ProjectApi,
Configuration
} from '@ory/client';
const configuration = new Configuration();
const apiInstance = new ProjectApi(configuration);
let project: string; // (default to undefined)
const { status, data } = await apiInstance.getProjectMembers(
project
);
```
|Name | Type | Description | Notes|
|------------- | ------------- | ------------- | -------------|
| **project** | [**string**] | | defaults to undefined|
**Array<ProjectMember>**
[](../README.md
- **Content-Type**: Not defined
- **Accept**: application/json
| Status code | Description | Response headers |
|-------------|-------------|------------------|
|**200** | projectMembers | - |
|**401** | genericError | - |
|**406** | genericError | - |
|**0** | genericError | - |
[[Back to top]](
> ListOrganizationsResponse listOrganizations()
Deprecated: use getProject instead Lists all Enterprise SSO organizations in a project.
### Example
```typescript
import {
ProjectApi,
Configuration
} from '@ory/client';
const configuration = new Configuration();
const apiInstance = new ProjectApi(configuration);
let projectId: string; //Project ID The project\'s ID. (default to undefined)
let pageSize: number; //Items per Page This is the number of items per page to return. For details on pagination please head over to the [pagination documentation](https://www.ory.com/docs/ecosystem/api-design#pagination). (optional) (default to 250)
let pageToken: string; //Next Page Token The next page token. For details on pagination please head over to the [pagination documentation](https://www.ory.com/docs/ecosystem/api-design#pagination). (optional) (default to undefined)
let domain: string; //Domain If set, only organizations with that domain will be returned. (optional) (default to undefined)
const { status, data } = await apiInstance.listOrganizations(
projectId,
pageSize,
pageToken,
domain
);
```
|Name | Type | Description | Notes|
|------------- | ------------- | ------------- | -------------|
| **projectId** | [**string**] | Project ID The project\&
| **pageSize** | [**number**] | Items per Page This is the number of items per page to return. For details on pagination please head over to the [pagination documentation](https://www.ory.com/docs/ecosystem/api-design#pagination). | (optional) defaults to 250|
| **pageToken** | [**string**] | Next Page Token The next page token. For details on pagination please head over to the [pagination documentation](https://www.ory.com/docs/ecosystem/api-design#pagination). | (optional) defaults to undefined|
| **domain** | [**string**] | Domain If set, only organizations with that domain will be returned. | (optional) defaults to undefined|
**ListOrganizationsResponse**
[](../README.md
- **Content-Type**: Not defined
- **Accept**: application/json
| Status code | Description | Response headers |
|-------------|-------------|------------------|
|**200** | listOrganizationsResponse | - |
|**400** | errorGeneric | - |
|**403** | errorGeneric | - |
|**0** | errorGeneric | - |
[[Back to top]](
> Array<ProjectApiKey> listProjectApiKeys()
A list of all the project\'s API keys.
### Example
```typescript
import {
ProjectApi,
Configuration
} from '@ory/client';
const configuration = new Configuration();
const apiInstance = new ProjectApi(configuration);
let project: string; //The Project ID or Project slug (default to undefined)
const { status, data } = await apiInstance.listProjectApiKeys(
project
);
```
|Name | Type | Description | Notes|
|------------- | ------------- | ------------- | -------------|
| **project** | [**string**] | The Project ID or Project slug | defaults to undefined|
**Array<ProjectApiKey>**
[](../README.md
- **Content-Type**: Not defined
- **Accept**: application/json
| Status code | Description | Response headers |
|-------------|-------------|------------------|
|**200** | projectApiKeys | - |
|**0** | errorGeneric | - |
[[Back to top]](
> Array<ProjectMetadata> listProjects()
Lists all projects you have access to.
### Example
```typescript
import {
ProjectApi,
Configuration
} from '@ory/client';
const configuration = new Configuration();
const apiInstance = new ProjectApi(configuration);
const { status, data } = await apiInstance.listProjects();
```
This endpoint does not have any parameters.
**Array<ProjectMetadata>**
[](../README.md
- **Content-Type**: Not defined
- **Accept**: application/json
| Status code | Description | Response headers |
|-------------|-------------|------------------|
|**200** | projectMetadataList | - |
|**401** | errorGeneric | - |
|**403** | errorGeneric | - |
|**404** | errorGeneric | - |
|**0** | errorGeneric | - |
[[Back to top]](
> SuccessfulProjectUpdate patchProject()
Deprecated: Use the `patchProjectWithRevision` endpoint instead to specify the exact revision the patch was generated for. This endpoints allows you to patch individual Ory Network project configuration keys for Ory\'s services (identity, permission, ...). The configuration format is fully compatible with the open source projects for the respective services (e.g. Ory Kratos for Identity, Ory Keto for Permissions). This endpoint expects the `version` key to be set in the payload. If it is unset, it will try to import the config as if it is from the most recent version. If you have an older version of a configuration, you should set the version key in the payload! While this endpoint is able to process all configuration items related to features (e.g. password reset), it does not support operational configuration items (e.g. port, tracing, logging) otherwise available in the open source. For configuration items that can not be translated to the Ory Network, this endpoint will return a list of warnings to help you understand which parts of your config could not be processed.
### Example
```typescript
import {
ProjectApi,
Configuration
} from '@ory/client';
const configuration = new Configuration();
const apiInstance = new ProjectApi(configuration);
let projectId: string; //Project ID The project\'s ID. (default to undefined)
let jsonPatch: Array<JsonPatch>; // (optional)
const { status, data } = await apiInstance.patchProject(
projectId,
jsonPatch
);
```
|Name | Type | Description | Notes|
|------------- | ------------- | ------------- | -------------|
| **jsonPatch** | **Array<JsonPatch>**| | |
| **projectId** | [**string**] | Project ID The project\&
**SuccessfulProjectUpdate**
[](../README.md
- **Content-Type**: application/json
- **Accept**: application/json
| Status code | Description | Response headers |
|-------------|-------------|------------------|
|**200** | successfulProjectUpdate | - |
|**400** | errorGeneric | - |
|**401** | errorGeneric | - |
|**403** | errorGeneric | - |
|**404** | errorGeneric | - |
|**0** | errorGeneric | - |
[[Back to top]](
> SuccessfulProjectUpdate patchProjectWithRevision()
This endpoints allows you to patch individual Ory Network Project configuration keys for Ory\'s services (identity, permission, ...). The configuration format is fully compatible with the open source projects for the respective services (e.g. Ory Kratos for Identity, Ory Keto for Permissions). This endpoint expects the `version` key to be set in the payload. If it is unset, it will try to import the config as if it is from the most recent version. If you have an older version of a configuration, you should set the version key in the payload! While this endpoint is able to process all configuration items related to features (e.g. password reset), it does not support operational configuration items (e.g. port, tracing, logging) otherwise available in the open source. For configuration items that can not be translated to the Ory Network, this endpoint will return a list of warnings to help you understand which parts of your config could not be processed.
### Example
```typescript
import {
ProjectApi,
Configuration
} from '@ory/client';
const configuration = new Configuration();
const apiInstance = new ProjectApi(configuration);
let projectId: string; //Project ID The project\'s ID. (default to undefined)
let revisionId: string; //Revision ID The revision ID that this patch was generated for. (default to undefined)
let jsonPatch: Array<JsonPatch>; // (optional)
const { status, data } = await apiInstance.patchProjectWithRevision(
projectId,
revisionId,
jsonPatch
);
```
|Name | Type | Description | Notes|
|------------- | ------------- | ------------- | -------------|
| **jsonPatch** | **Array<JsonPatch>**| | |
| **projectId** | [**string**] | Project ID The project\&
| **revisionId** | [**string**] | Revision ID The revision ID that this patch was generated for. | defaults to undefined|
**SuccessfulProjectUpdate**
[](../README.md
- **Content-Type**: application/json
- **Accept**: application/json
| Status code | Description | Response headers |
|-------------|-------------|------------------|
|**200** | successfulProjectUpdate | - |
|**400** | errorGeneric | - |
|**401** | errorGeneric | - |
|**403** | errorGeneric | - |
|**404** | errorGeneric | - |
|**409** | errorGeneric | - |
|**0** | errorGeneric | - |
[[Back to top]](
> purgeProject()
!! Use with extreme caution !! Using this API endpoint you can purge (completely delete) a project and its data. This action can not be undone and will delete ALL your data. Calling this endpoint will additionally delete custom domains and other related data. If the project is linked to a subscription, the subscription needs to be unlinked first.
### Example
```typescript
import {
ProjectApi,
Configuration
} from '@ory/client';
const configuration = new Configuration();
const apiInstance = new ProjectApi(configuration);
let projectId: string; //Project ID The project\'s ID. (default to undefined)
const { status, data } = await apiInstance.purgeProject(
projectId
);
```
|Name | Type | Description | Notes|
|------------- | ------------- | ------------- | -------------|
| **projectId** | [**string**] | Project ID The project\&
void (empty response body)
[](../README.md
- **Content-Type**: Not defined
- **Accept**: application/json
| Status code | Description | Response headers |
|-------------|-------------|------------------|
|**204** | Empty responses are sent when, for example, resources are deleted. The HTTP status code for empty responses is typically 201. | - |
|**401** | genericError | - |
|**403** | genericError | - |
|**404** | genericError | - |
|**0** | genericError | - |
[[Back to top]](
> removeProjectMember()
This also sets their invite status to `REMOVED`. This endpoint requires the user to be a member of the project with the role `OWNER`.
```typescript
import {
ProjectApi,
Configuration
} from '@ory/client';
const configuration = new Configuration();
const apiInstance = new ProjectApi(configuration);
let project: string; // (default to undefined)
let member: string; // (default to undefined)
const { status, data } = await apiInstance.removeProjectMember(
project,
member
);
```
|Name | Type | Description | Notes|
|------------- | ------------- | ------------- | -------------|
| **project** | [**string**] | | defaults to undefined|
| **member** | [**string**] | | defaults to undefined|
void (empty response body)
[](../README.md
- **Content-Type**: Not defined
- **Accept**: application/json
| Status code | Description | Response headers |
|-------------|-------------|------------------|
|**204** | Empty responses are sent when, for example, resources are deleted. The HTTP status code for empty responses is typically 201. | - |
|**401** | genericError | - |
|**406** | genericError | - |
|**0** | genericError | - |
[[Back to top]](
> SuccessfulProjectUpdate setProject()
This endpoints allows you to update the Ory Network project configuration for individual services (identity, permission, ...). The configuration is fully compatible with the open source projects for the respective services (e.g. Ory Kratos for Identity, Ory Keto for Permissions). This endpoint expects the `version` key to be set in the payload. If it is unset, it will try to import the config as if it is from the most recent version. If you have an older version of a configuration, you should set the version key in the payload! While this endpoint is able to process all configuration items related to features (e.g. password reset), it does not support operational configuration items (e.g. port, tracing, logging) otherwise available in the open source. For configuration items that can not be translated to the Ory Network, this endpoint will return a list of warnings to help you understand which parts of your config could not be processed. Be aware that updating any service\'s configuration will completely override your current configuration for that service!
### Example
```typescript
import {
ProjectApi,
Configuration,
SetProject
} from '@ory/client';
const configuration = new Configuration();
const apiInstance = new ProjectApi(configuration);
let projectId: string; //Project ID The project\'s ID. (default to undefined)
let setProject: SetProject; // (optional)
const { status, data } = await apiInstance.setProject(
projectId,
setProject
);
```
|Name | Type | Description | Notes|
|------------- | ------------- | ------------- | -------------|
| **setProject** | **SetProject**| | |
| **projectId** | [**string**] | Project ID The project\&
**SuccessfulProjectUpdate**
[](../README.md
- **Content-Type**: application/json
- **Accept**: application/json
| Status code | Description | Response headers |
|-------------|-------------|------------------|
|**200** | successfulProjectUpdate | - |
|**400** | errorGeneric | - |
|**401** | errorGeneric | - |
|**403** | errorGeneric | - |
|**404** | errorGeneric | - |
|**0** | errorGeneric | - |
[[Back to top]](
> Organization updateOrganization()
Deprecated: use setProject or patchProjectWithRevision instead Updates an Enterprise SSO Organization in a project by its ID.
### Example
```typescript
import {
ProjectApi,
Configuration,
OrganizationBody
} from '@ory/client';
const configuration = new Configuration();
const apiInstance = new ProjectApi(configuration);
let projectId: string; //Project ID The project\'s ID. (default to undefined)
let organizationId: string; //Organization ID The Organization\'s ID. (default to undefined)
let organizationBody: OrganizationBody; // (optional)
const { status, data } = await apiInstance.updateOrganization(
projectId,
organizationId,
organizationBody
);
```
|Name | Type | Description | Notes|
|------------- | ------------- | ------------- | -------------|
| **organizationBody** | **OrganizationBody**| | |
| **projectId** | [**string**] | Project ID The project\&
| **organizationId** | [**string**] | Organization ID The Organization\&
**Organization**
[](../README.md
- **Content-Type**: application/json
- **Accept**: application/json
| Status code | Description | Response headers |
|-------------|-------------|------------------|
|**200** | organization | - |
|**400** | errorGeneric | - |
|**403** | errorGeneric | - |
|**404** | errorGeneric | - |
|**409** | errorGeneric | - |
|**0** | errorGeneric | - |
[[Back to top]](
> OnboardingPortalLink updateOrganizationOnboardingPortalLink()
Update a onboarding portal link for an organization.
### Example
```typescript
import {
ProjectApi,
Configuration,
UpdateOrganizationOnboardingPortalLinkBody
} from '@ory/client';
const configuration = new Configuration();
const apiInstance = new ProjectApi(configuration);
let projectId: string; //Project ID The project\'s ID. (default to undefined)
let organizationId: string; //Organization ID The Organization\'s ID. (default to undefined)
let onboardingPortalLinkId: string; // (default to undefined)
let updateOrganizationOnboardingPortalLinkBody: UpdateOrganizationOnboardingPortalLinkBody; // (optional)
const { status, data } = await apiInstance.updateOrganizationOnboardingPortalLink(
projectId,
organizationId,
onboardingPortalLinkId,
updateOrganizationOnboardingPortalLinkBody
);
```
|Name | Type | Description | Notes|
|------------- | ------------- | ------------- | -------------|
| **updateOrganizationOnboardingPortalLinkBody** | **UpdateOrganizationOnboardingPortalLinkBody**| | |
| **projectId** | [**string**] | Project ID The project\&
| **organizationId** | [**string**] | Organization ID The Organization\&
| **onboardingPortalLinkId** | [**string**] | | defaults to undefined|
**OnboardingPortalLink**
[](../README.md
- **Content-Type**: application/json
- **Accept**: application/json
| Status code | Description | Response headers |
|-------------|-------------|------------------|
|**200** | onboardingPortalLink | - |
|**0** | errorGeneric | - |
[[Back to top]](