chore(docs): Generated References (#8828)

Generated the following references: - `auth` - `core_flows` - `fulfillment` - `fulfillment_models` - `helper_steps` - `medusa_config` - `modules` - `modules_sdk` - `order` - `order_models` - `payment` - `stock_location_next` - `types`
2024-08-28 06:53:38 +00:00
1 parent e0a3b8fc2e
commit 841cb69ba9
@@ -0,0 +1,62 @@
+---
+displayed_sidebar: authReference
+slug: /references/auth/createProviderIdentities
+sidebar_label: createProviderIdentities
+---
+
+import { TypeList } from "docs-ui"
+
+# createProviderIdentities - Auth Module Reference
+
+This documentation provides a reference to the `createProviderIdentities` method. This belongs to the Auth Module.
+
+## createProviderIdentities(data, sharedContext?): Promise&#60;[ProviderIdentityDTO](../../../interfaces/auth.ProviderIdentityDTO/page.mdx)[]&#62;
+
+This method creates provider identities.
+
+### Example
+
+```ts
+const providerIdentities = await authModuleService.createProviderIdentities([
+  {
+     provider: "emailpass",
+     entity_id: "user@example.com",
+     auth_identity_id: "uid_1"
+  },
+  {
+     provider: "github",
+     entity_id: "github_handle",
+     auth_identity_id: "uid_1"
+  },
+])
+```
+
+### Parameters
+
+<TypeList types={[{"name":"data","type":"[CreateProviderIdentityDTO](../../../interfaces/auth.CreateProviderIdentityDTO/page.mdx)[]","description":"The provider identities to be created.","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"provider","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"entity_id","type":"`string`","description":"The user's identifier. For example, when using the `emailpass`\nprovider, the `entity_id` would be the user's email.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"id","type":"`string`","description":"The ID of the provider identity.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"auth_identity_id","type":"`string`","description":"The auth identity linked to the provider identity. Needs to be specified if creating a new provider identity directly.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"provider_metadata","type":"`Record<string, unknown>`","description":"Holds custom data related to the provider in key-value pairs.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"user_metadata","type":"`Record<string, unknown>`","description":"Holds custom data related to the user in key-value pairs.","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"sharedContext","type":"[Context](../../../interfaces/auth.Context/page.mdx)","description":"A context used to share resources, such as transaction manager, between the application and the module.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"transactionManager","type":"TManager","description":"An instance of a transaction manager of type `TManager`, which is a typed parameter passed to the context to specify the type of the `transactionManager`.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"manager","type":"TManager","description":"An instance of a manager, typically an entity manager, of type `TManager`, which is a typed parameter passed to the context to specify the type of the `manager`.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"isolationLevel","type":"`string`","description":"A string indicating the isolation level of the context. Possible values are `READ UNCOMMITTED`, `READ COMMITTED`, `REPEATABLE READ`, or `SERIALIZABLE`.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"enableNestedTransactions","type":"`boolean`","description":"A boolean value indicating whether nested transactions are enabled.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"eventGroupId","type":"`string`","description":"A string indicating the ID of the group to aggregate the events to be emitted at a later point.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"transactionId","type":"`string`","description":"A string indicating the ID of the current transaction.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"messageAggregator","type":"[IMessageAggregator](../../../interfaces/auth.IMessageAggregator/page.mdx)","description":"An instance of a message aggregator, which is used to aggregate messages to be emitted at a later point.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"requestId","type":"`string`","description":"A string indicating the ID of the current request.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"idempotencyKey","type":"`string`","description":"A string indicating the idempotencyKey of the current workflow execution.","optional":true,"defaultValue":"","expandable":false,"children":[]}]}]} expandUrl="https://docs.medusajs.com/v2/advanced-development/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="createProviderIdentities"/>
+
+### Returns
+
+<TypeList types={[{"name":"Promise","type":"Promise&#60;[ProviderIdentityDTO](../../../interfaces/auth.ProviderIdentityDTO/page.mdx)[]&#62;","optional":false,"defaultValue":"","description":"The created provider identities.","expandable":false,"children":[{"name":"ProviderIdentityDTO[]","type":"[ProviderIdentityDTO](../../../interfaces/auth.ProviderIdentityDTO/page.mdx)[]","optional":false,"defaultValue":"","description":"","expandable":false,"children":[{"name":"ProviderIdentityDTO","type":"`object`","description":"The provider identity details.","optional":false,"defaultValue":"","expandable":false,"children":[]}]}]}]} expandUrl="https://docs.medusajs.com/v2/advanced-development/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="createProviderIdentities"/>
+
+## createProviderIdentities(data, sharedContext?): Promise&#60;[ProviderIdentityDTO](../../../interfaces/auth.ProviderIdentityDTO/page.mdx)&#62;
+
+This method creates a provider identity.
+
+### Example
+
+```ts
+const providerIdentity = await authModuleService.createProviderIdentities({
+    provider: "github",
+    entity_id: "github_handle",
+    auth_identity_id: "uid_1"
+})
+```
+
+### Parameters
+
+<TypeList types={[{"name":"data","type":"[CreateProviderIdentityDTO](../../../interfaces/auth.CreateProviderIdentityDTO/page.mdx)","description":"The provider identity to be created.","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"provider","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"entity_id","type":"`string`","description":"The user's identifier. For example, when using the `emailpass`\nprovider, the `entity_id` would be the user's email.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"id","type":"`string`","description":"The ID of the provider identity.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"auth_identity_id","type":"`string`","description":"The auth identity linked to the provider identity. Needs to be specified if creating a new provider identity directly.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"provider_metadata","type":"`Record<string, unknown>`","description":"Holds custom data related to the provider in key-value pairs.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"user_metadata","type":"`Record<string, unknown>`","description":"Holds custom data related to the user in key-value pairs.","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"sharedContext","type":"[Context](../../../interfaces/auth.Context/page.mdx)","description":"A context used to share resources, such as transaction manager, between the application and the module.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"transactionManager","type":"TManager","description":"An instance of a transaction manager of type `TManager`, which is a typed parameter passed to the context to specify the type of the `transactionManager`.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"manager","type":"TManager","description":"An instance of a manager, typically an entity manager, of type `TManager`, which is a typed parameter passed to the context to specify the type of the `manager`.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"isolationLevel","type":"`string`","description":"A string indicating the isolation level of the context. Possible values are `READ UNCOMMITTED`, `READ COMMITTED`, `REPEATABLE READ`, or `SERIALIZABLE`.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"enableNestedTransactions","type":"`boolean`","description":"A boolean value indicating whether nested transactions are enabled.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"eventGroupId","type":"`string`","description":"A string indicating the ID of the group to aggregate the events to be emitted at a later point.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"transactionId","type":"`string`","description":"A string indicating the ID of the current transaction.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"messageAggregator","type":"[IMessageAggregator](../../../interfaces/auth.IMessageAggregator/page.mdx)","description":"An instance of a message aggregator, which is used to aggregate messages to be emitted at a later point.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"requestId","type":"`string`","description":"A string indicating the ID of the current request.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"idempotencyKey","type":"`string`","description":"A string indicating the idempotencyKey of the current workflow execution.","optional":true,"defaultValue":"","expandable":false,"children":[]}]}]} expandUrl="https://docs.medusajs.com/v2/advanced-development/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="createProviderIdentities"/>
+
+### Returns
+
+<TypeList types={[{"name":"Promise","type":"Promise&#60;[ProviderIdentityDTO](../../../interfaces/auth.ProviderIdentityDTO/page.mdx)&#62;","optional":false,"defaultValue":"","description":"The created provider identity.","expandable":false,"children":[{"name":"ProviderIdentityDTO","type":"[ProviderIdentityDTO](../../../interfaces/auth.ProviderIdentityDTO/page.mdx)","optional":false,"defaultValue":"","description":"The provider identity details.","expandable":false,"children":[{"name":"id","type":"`string`","description":"The ID of the provider identity.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"provider","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"entity_id","type":"`string`","description":"The user's identifier. For example, when using the `emailpass`\nprovider, the `entity_id` would be the user's email.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"auth_identity","type":"[AuthIdentityDTO](../../../interfaces/auth.AuthIdentityDTO/page.mdx)","description":"The auth identity linked to the provider identity.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"id","type":"`string`","description":"The ID of the auth identity.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"provider_identities","type":"[ProviderIdentityDTO](../../../interfaces/auth.ProviderIdentityDTO/page.mdx)[]","description":"The list of provider identities linked to the auth identity.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"app_metadata","type":"`Record<string, unknown>`","description":"Holds information related to the actor IDs tied to the auth identity.","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"provider_metadata","type":"`Record<string, unknown>`","description":"Holds custom data related to the provider in key-value pairs.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"user_metadata","type":"`Record<string, unknown>`","description":"Holds custom data related to the user in key-value pairs.","optional":true,"defaultValue":"","expandable":false,"children":[]}]}]}]} expandUrl="https://docs.medusajs.com/v2/advanced-development/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="createProviderIdentities"/>
@@ -0,0 +1,27 @@
+---
+displayed_sidebar: authReference
+slug: /references/auth/deleteProviderIdentities
+sidebar_label: deleteProviderIdentities
+---
+
+import { TypeList } from "docs-ui"
+
+# deleteProviderIdentities - Auth Module Reference
+
+This documentation provides a reference to the `deleteProviderIdentities` method. This belongs to the Auth Module.
+
+This method deletes a provider identity by its ID.
+
+## Example
+
+```ts
+await authModuleService.deleteProviderIdentities(["provider_123", "provider_234"])
+```
+
+## Parameters
+
+<TypeList types={[{"name":"ids","type":"`string`[]","description":"The IDs of the provider identity.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"sharedContext","type":"[Context](../../../interfaces/auth.Context/page.mdx)","description":"A context used to share resources, such as transaction manager, between the application and the module.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"transactionManager","type":"TManager","description":"An instance of a transaction manager of type `TManager`, which is a typed parameter passed to the context to specify the type of the `transactionManager`.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"manager","type":"TManager","description":"An instance of a manager, typically an entity manager, of type `TManager`, which is a typed parameter passed to the context to specify the type of the `manager`.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"isolationLevel","type":"`string`","description":"A string indicating the isolation level of the context. Possible values are `READ UNCOMMITTED`, `READ COMMITTED`, `REPEATABLE READ`, or `SERIALIZABLE`.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"enableNestedTransactions","type":"`boolean`","description":"A boolean value indicating whether nested transactions are enabled.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"eventGroupId","type":"`string`","description":"A string indicating the ID of the group to aggregate the events to be emitted at a later point.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"transactionId","type":"`string`","description":"A string indicating the ID of the current transaction.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"messageAggregator","type":"[IMessageAggregator](../../../interfaces/auth.IMessageAggregator/page.mdx)","description":"An instance of a message aggregator, which is used to aggregate messages to be emitted at a later point.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"requestId","type":"`string`","description":"A string indicating the ID of the current request.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"idempotencyKey","type":"`string`","description":"A string indicating the idempotencyKey of the current workflow execution.","optional":true,"defaultValue":"","expandable":false,"children":[]}]}]} expandUrl="https://docs.medusajs.com/v2/advanced-development/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="deleteProviderIdentities"/>
+
+## Returns
+
+<TypeList types={[{"name":"Promise","type":"Promise&#60;void&#62;","optional":false,"defaultValue":"","description":"Resolves when &#123;summary&#125;","expandable":false,"children":[]}]} expandUrl="https://docs.medusajs.com/v2/advanced-development/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="deleteProviderIdentities"/>
@@ -40,7 +40,7 @@ const [authIdentities, count] =

 ## Parameters

-<TypeList types={[{"name":"filters","type":"[FilterableAuthIdentityProps](../../../interfaces/auth.FilterableAuthIdentityProps/page.mdx)","description":"The filters to apply on the retrieved auth identities.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"id","type":"`string`[]","description":"The IDs to filter the auth identity by.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"provider_identities","type":"`object`","description":"The provider identities to filter the auth identity by.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"entity_id","type":"`string`","description":"Filter the provider identities by the ID of the provider identity ID they are linked to.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"provider","type":"`string`","description":"Filter the provider identities by the provider handle.","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"$and","type":"([FilterableAuthIdentityProps](../../../interfaces/auth.FilterableAuthIdentityProps/page.mdx) \\| [BaseFilterable](../../../interfaces/auth.BaseFilterable/page.mdx)&#60;[FilterableAuthIdentityProps](../../../interfaces/auth.FilterableAuthIdentityProps/page.mdx)&#62;)[]","description":"An array of filters to apply on the entity, where each item in the array is joined with an \"and\" condition.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"id","type":"`string`[]","description":"The IDs to filter the auth identity by.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"provider_identities","type":"`object`","description":"The provider identities to filter the auth identity by.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$and","type":"([FilterableAuthIdentityProps](../../../interfaces/auth.FilterableAuthIdentityProps/page.mdx) \\| [BaseFilterable](../../../interfaces/auth.BaseFilterable/page.mdx)&#60;[FilterableAuthIdentityProps](../../../interfaces/auth.FilterableAuthIdentityProps/page.mdx)&#62;)[]","description":"An array of filters to apply on the entity, where each item in the array is joined with an \"and\" condition.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$or","type":"([FilterableAuthIdentityProps](../../../interfaces/auth.FilterableAuthIdentityProps/page.mdx) \\| [BaseFilterable](../../../interfaces/auth.BaseFilterable/page.mdx)&#60;[FilterableAuthIdentityProps](../../../interfaces/auth.FilterableAuthIdentityProps/page.mdx)&#62;)[]","description":"An array of filters to apply on the entity, where each item in the array is joined with an \"or\" condition.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$and","type":"([BaseFilterable](../../../interfaces/auth.BaseFilterable/page.mdx)&#60;T&#62; \\| T)[]","description":"An array of filters to apply on the entity, where each item in the array is joined with an \"and\" condition.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$or","type":"([BaseFilterable](../../../interfaces/auth.BaseFilterable/page.mdx)&#60;T&#62; \\| T)[]","description":"An array of filters to apply on the entity, where each item in the array is joined with an \"or\" condition.","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"$or","type":"([FilterableAuthIdentityProps](../../../interfaces/auth.FilterableAuthIdentityProps/page.mdx) \\| [BaseFilterable](../../../interfaces/auth.BaseFilterable/page.mdx)&#60;[FilterableAuthIdentityProps](../../../interfaces/auth.FilterableAuthIdentityProps/page.mdx)&#62;)[]","description":"An array of filters to apply on the entity, where each item in the array is joined with an \"or\" condition.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"id","type":"`string`[]","description":"The IDs to filter the auth identity by.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"provider_identities","type":"`object`","description":"The provider identities to filter the auth identity by.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$and","type":"([FilterableAuthIdentityProps](../../../interfaces/auth.FilterableAuthIdentityProps/page.mdx) \\| [BaseFilterable](../../../interfaces/auth.BaseFilterable/page.mdx)&#60;[FilterableAuthIdentityProps](../../../interfaces/auth.FilterableAuthIdentityProps/page.mdx)&#62;)[]","description":"An array of filters to apply on the entity, where each item in the array is joined with an \"and\" condition.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$or","type":"([FilterableAuthIdentityProps](../../../interfaces/auth.FilterableAuthIdentityProps/page.mdx) \\| [BaseFilterable](../../../interfaces/auth.BaseFilterable/page.mdx)&#60;[FilterableAuthIdentityProps](../../../interfaces/auth.FilterableAuthIdLine truncated
+<TypeList types={[{"name":"filters","type":"[FilterableAuthIdentityProps](../../../interfaces/auth.FilterableAuthIdentityProps/page.mdx)","description":"The filters to apply on the retrieved auth identities.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"id","type":"`string`[]","description":"The IDs to filter the auth identity by.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"provider_identities","type":"`object`","description":"The provider identities to filter the auth identity by.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"entity_id","type":"`string`","description":"Filter the provider identities by the ID of the provider identity ID they are linked to.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"provider","type":"`string`","description":"Filter the provider identities by the provider handle.","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"app_metadata","type":"`Record<string, unknown>`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$and","type":"([FilterableAuthIdentityProps](../../../interfaces/auth.FilterableAuthIdentityProps/page.mdx) \\| [BaseFilterable](../../../interfaces/auth.BaseFilterable/page.mdx)&#60;[FilterableAuthIdentityProps](../../../interfaces/auth.FilterableAuthIdentityProps/page.mdx)&#62;)[]","description":"An array of filters to apply on the entity, where each item in the array is joined with an \"and\" condition.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"id","type":"`string`[]","description":"The IDs to filter the auth identity by.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"provider_identities","type":"`object`","description":"The provider identities to filter the auth identity by.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"app_metadata","type":"`Record<string, unknown>`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$and","type":"([FilterableAuthIdentityProps](../../../interfaces/auth.FilterableAuthIdentityProps/page.mdx) \\| [BaseFilterable](../../../interfaces/auth.BaseFilterable/page.mdx)&#60;[FilterableAuthIdentityProps](../../../interfaces/auth.FilterableAuthIdentityProps/page.mdx)&#62;)[]","description":"An array of filters to apply on the entity, where each item in the array is joined with an \"and\" condition.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$or","type":"([FilterableAuthIdentityProps](../../../interfaces/auth.FilterableAuthIdentityProps/page.mdx) \\| [BaseFilterable](../../../interfaces/auth.BaseFilterable/page.mdx)&#60;[FilterableAuthIdentityProps](../../../interfaces/auth.FilterableAuthIdentityProps/page.mdx)&#62;)[]","description":"An array of filters to apply on the entity, where each item in the array is joined with an \"or\" condition.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$and","type":"([BaseFilterable](../../../interfaces/auth.BaseFilterable/page.mdx)&#60;T&#62; \\| T)[]","description":"An array of filters to apply on the entity, where each item in the array is joined with an \"and\" condition.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$or","type":"([BaseFilterable](../../../interfaces/auth.BaseFilterable/page.mdx)&#60;T&#62; \\| T)[]","description":"An array of filters to apply on the entity, where each item in the array is joined with an \"or\" condition.","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"$or","type":"([FilterableAuthIdentityProps](../../../interfaces/auth.FilterableAuthIdentityProps/page.mdx) \\| [BaseFilterable](../../../interfaces/auth.BaseFilterable/page.mdx)&#60;[FilterableAuthIdentityProps](../../../interfaces/auth.FilterableAuthIdentityProps/page.mdx)&#62;)[]","description":"An array of filters to apply on the entity, where each item in the array is joined with an \"or\" condition.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"id","type":"`string`[]","description":"The IDs to filter the auth identity by.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"provider_identities","type":"`object`","description":"The provider identities to filter the auth identity by.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"app_metadata","type":"`Record<string, unknown>`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$and","type":"([FilterableAuthIdentityProps](../../../interfaces/auth.FilterableAuthIdentityProps/page.mdx) \\| [BaseFilterable](../../../interfaces/auth.BaseFilterable/page.mdx)&#60;[FilterableAuthIdentityProps](../../../interfaces/auth.FilterableAuthIdentityProps/page.mdx)&#62;)[]","description":"An array of Line truncated

 ## Returns

@@ -38,7 +38,7 @@ const authIdentities = await authModuleService.listAuthIdentities(

 ## Parameters

-<TypeList types={[{"name":"filters","type":"[FilterableAuthIdentityProps](../../../interfaces/auth.FilterableAuthIdentityProps/page.mdx)","description":"The filters to apply on the retrieved auth identities.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"id","type":"`string`[]","description":"The IDs to filter the auth identity by.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"provider_identities","type":"`object`","description":"The provider identities to filter the auth identity by.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"entity_id","type":"`string`","description":"Filter the provider identities by the ID of the provider identity ID they are linked to.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"provider","type":"`string`","description":"Filter the provider identities by the provider handle.","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"$and","type":"([FilterableAuthIdentityProps](../../../interfaces/auth.FilterableAuthIdentityProps/page.mdx) \\| [BaseFilterable](../../../interfaces/auth.BaseFilterable/page.mdx)&#60;[FilterableAuthIdentityProps](../../../interfaces/auth.FilterableAuthIdentityProps/page.mdx)&#62;)[]","description":"An array of filters to apply on the entity, where each item in the array is joined with an \"and\" condition.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"id","type":"`string`[]","description":"The IDs to filter the auth identity by.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"provider_identities","type":"`object`","description":"The provider identities to filter the auth identity by.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$and","type":"([FilterableAuthIdentityProps](../../../interfaces/auth.FilterableAuthIdentityProps/page.mdx) \\| [BaseFilterable](../../../interfaces/auth.BaseFilterable/page.mdx)&#60;[FilterableAuthIdentityProps](../../../interfaces/auth.FilterableAuthIdentityProps/page.mdx)&#62;)[]","description":"An array of filters to apply on the entity, where each item in the array is joined with an \"and\" condition.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$or","type":"([FilterableAuthIdentityProps](../../../interfaces/auth.FilterableAuthIdentityProps/page.mdx) \\| [BaseFilterable](../../../interfaces/auth.BaseFilterable/page.mdx)&#60;[FilterableAuthIdentityProps](../../../interfaces/auth.FilterableAuthIdentityProps/page.mdx)&#62;)[]","description":"An array of filters to apply on the entity, where each item in the array is joined with an \"or\" condition.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$and","type":"([BaseFilterable](../../../interfaces/auth.BaseFilterable/page.mdx)&#60;T&#62; \\| T)[]","description":"An array of filters to apply on the entity, where each item in the array is joined with an \"and\" condition.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$or","type":"([BaseFilterable](../../../interfaces/auth.BaseFilterable/page.mdx)&#60;T&#62; \\| T)[]","description":"An array of filters to apply on the entity, where each item in the array is joined with an \"or\" condition.","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"$or","type":"([FilterableAuthIdentityProps](../../../interfaces/auth.FilterableAuthIdentityProps/page.mdx) \\| [BaseFilterable](../../../interfaces/auth.BaseFilterable/page.mdx)&#60;[FilterableAuthIdentityProps](../../../interfaces/auth.FilterableAuthIdentityProps/page.mdx)&#62;)[]","description":"An array of filters to apply on the entity, where each item in the array is joined with an \"or\" condition.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"id","type":"`string`[]","description":"The IDs to filter the auth identity by.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"provider_identities","type":"`object`","description":"The provider identities to filter the auth identity by.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$and","type":"([FilterableAuthIdentityProps](../../../interfaces/auth.FilterableAuthIdentityProps/page.mdx) \\| [BaseFilterable](../../../interfaces/auth.BaseFilterable/page.mdx)&#60;[FilterableAuthIdentityProps](../../../interfaces/auth.FilterableAuthIdentityProps/page.mdx)&#62;)[]","description":"An array of filters to apply on the entity, where each item in the array is joined with an \"and\" condition.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$or","type":"([FilterableAuthIdentityProps](../../../interfaces/auth.FilterableAuthIdentityProps/page.mdx) \\| [BaseFilterable](../../../interfaces/auth.BaseFilterable/page.mdx)&#60;[FilterableAuthIdentityProps](../../../interfaces/auth.FilterableAuthIdLine truncated
+<TypeList types={[{"name":"filters","type":"[FilterableAuthIdentityProps](../../../interfaces/auth.FilterableAuthIdentityProps/page.mdx)","description":"The filters to apply on the retrieved auth identities.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"id","type":"`string`[]","description":"The IDs to filter the auth identity by.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"provider_identities","type":"`object`","description":"The provider identities to filter the auth identity by.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"entity_id","type":"`string`","description":"Filter the provider identities by the ID of the provider identity ID they are linked to.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"provider","type":"`string`","description":"Filter the provider identities by the provider handle.","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"app_metadata","type":"`Record<string, unknown>`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$and","type":"([FilterableAuthIdentityProps](../../../interfaces/auth.FilterableAuthIdentityProps/page.mdx) \\| [BaseFilterable](../../../interfaces/auth.BaseFilterable/page.mdx)&#60;[FilterableAuthIdentityProps](../../../interfaces/auth.FilterableAuthIdentityProps/page.mdx)&#62;)[]","description":"An array of filters to apply on the entity, where each item in the array is joined with an \"and\" condition.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"id","type":"`string`[]","description":"The IDs to filter the auth identity by.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"provider_identities","type":"`object`","description":"The provider identities to filter the auth identity by.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"app_metadata","type":"`Record<string, unknown>`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$and","type":"([FilterableAuthIdentityProps](../../../interfaces/auth.FilterableAuthIdentityProps/page.mdx) \\| [BaseFilterable](../../../interfaces/auth.BaseFilterable/page.mdx)&#60;[FilterableAuthIdentityProps](../../../interfaces/auth.FilterableAuthIdentityProps/page.mdx)&#62;)[]","description":"An array of filters to apply on the entity, where each item in the array is joined with an \"and\" condition.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$or","type":"([FilterableAuthIdentityProps](../../../interfaces/auth.FilterableAuthIdentityProps/page.mdx) \\| [BaseFilterable](../../../interfaces/auth.BaseFilterable/page.mdx)&#60;[FilterableAuthIdentityProps](../../../interfaces/auth.FilterableAuthIdentityProps/page.mdx)&#62;)[]","description":"An array of filters to apply on the entity, where each item in the array is joined with an \"or\" condition.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$and","type":"([BaseFilterable](../../../interfaces/auth.BaseFilterable/page.mdx)&#60;T&#62; \\| T)[]","description":"An array of filters to apply on the entity, where each item in the array is joined with an \"and\" condition.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$or","type":"([BaseFilterable](../../../interfaces/auth.BaseFilterable/page.mdx)&#60;T&#62; \\| T)[]","description":"An array of filters to apply on the entity, where each item in the array is joined with an \"or\" condition.","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"$or","type":"([FilterableAuthIdentityProps](../../../interfaces/auth.FilterableAuthIdentityProps/page.mdx) \\| [BaseFilterable](../../../interfaces/auth.BaseFilterable/page.mdx)&#60;[FilterableAuthIdentityProps](../../../interfaces/auth.FilterableAuthIdentityProps/page.mdx)&#62;)[]","description":"An array of filters to apply on the entity, where each item in the array is joined with an \"or\" condition.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"id","type":"`string`[]","description":"The IDs to filter the auth identity by.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"provider_identities","type":"`object`","description":"The provider identities to filter the auth identity by.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"app_metadata","type":"`Record<string, unknown>`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$and","type":"([FilterableAuthIdentityProps](../../../interfaces/auth.FilterableAuthIdentityProps/page.mdx) \\| [BaseFilterable](../../../interfaces/auth.BaseFilterable/page.mdx)&#60;[FilterableAuthIdentityProps](../../../interfaces/auth.FilterableAuthIdentityProps/page.mdx)&#62;)[]","description":"An array of Line truncated

 ## Returns

@@ -0,0 +1,45 @@
+---
+displayed_sidebar: authReference
+slug: /references/auth/listProviderIdentities
+sidebar_label: listProviderIdentities
+---
+
+import { TypeList } from "docs-ui"
+
+# listProviderIdentities - Auth Module Reference
+
+This documentation provides a reference to the `listProviderIdentities` method. This belongs to the Auth Module.
+
+This method retrieves a paginated list of provider identities based on optional filters and configuration.
+
+## Example
+
+To retrieve a list of provider identities using their IDs:
+
+```ts
+const providerIdentities = await authModuleService.listProviderIdentities({
+  id: ["provider_123", "provider_234"],
+})
+```
+
+By default, only the first `15` records are retrieved. You can control pagination by specifying the `skip` and `take` properties of the `config` parameter:
+
+```ts
+const providerIdentities = await authModuleService.listProviderIdentities(
+  {
+    id: ["provider_123", "provider_234"],
+  },
+  {
+    take: 20,
+    skip: 2,
+  }
+)
+```
+
+## Parameters
+
+<TypeList types={[{"name":"filters","type":"[FilterableProviderIdentityProps](../../../interfaces/auth.FilterableProviderIdentityProps/page.mdx)","description":"The filters to apply on the retrieved provider identities.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"id","type":"`string`[]","description":"The IDs to filter the provider identity by.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"entity_id","type":"`string`","description":"Filter the provider identities by the ID of the provider identity they are linked to.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"provider","type":"`string`","description":"The provider handle to filter the provider identity by.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"provider_metadata","type":"`Record<string, unknown>`","description":"Holds custom data related to the provider in key-value pairs.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"user_metadata","type":"`Record<string, unknown>`","description":"Holds custom data related to the user in key-value pairs.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$and","type":"([FilterableProviderIdentityProps](../../../interfaces/auth.FilterableProviderIdentityProps/page.mdx) \\| [BaseFilterable](../../../interfaces/auth.BaseFilterable/page.mdx)&#60;[FilterableProviderIdentityProps](../../../interfaces/auth.FilterableProviderIdentityProps/page.mdx)&#62;)[]","description":"An array of filters to apply on the entity, where each item in the array is joined with an \"and\" condition.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"id","type":"`string`[]","description":"The IDs to filter the provider identity by.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"entity_id","type":"`string`","description":"Filter the provider identities by the ID of the provider identity they are linked to.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"provider","type":"`string`","description":"The provider handle to filter the provider identity by.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"provider_metadata","type":"`Record<string, unknown>`","description":"Holds custom data related to the provider in key-value pairs.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"user_metadata","type":"`Record<string, unknown>`","description":"Holds custom data related to the user in key-value pairs.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$and","type":"([FilterableProviderIdentityProps](../../../interfaces/auth.FilterableProviderIdentityProps/page.mdx) \\| [BaseFilterable](../../../interfaces/auth.BaseFilterable/page.mdx)&#60;[FilterableProviderIdentityProps](../../../interfaces/auth.FilterableProviderIdentityProps/page.mdx)&#62;)[]","description":"An array of filters to apply on the entity, where each item in the array is joined with an \"and\" condition.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$or","type":"([FilterableProviderIdentityProps](../../../interfaces/auth.FilterableProviderIdentityProps/page.mdx) \\| [BaseFilterable](../../../interfaces/auth.BaseFilterable/page.mdx)&#60;[FilterableProviderIdentityProps](../../../interfaces/auth.FilterableProviderIdentityProps/page.mdx)&#62;)[]","description":"An array of filters to apply on the entity, where each item in the array is joined with an \"or\" condition.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$and","type":"([BaseFilterable](../../../interfaces/auth.BaseFilterable/page.mdx)&#60;T&#62; \\| T)[]","description":"An array of filters to apply on the entity, where each item in the array is joined with an \"and\" condition.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$or","type":"([BaseFilterable](../../../interfaces/auth.BaseFilterable/page.mdx)&#60;T&#62; \\| T)[]","description":"An array of filters to apply on the entity, where each item in the array is joined with an \"or\" condition.","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"$or","type":"([FilterableProviderIdentityProps](../../../interfaces/auth.FilterableProviderIdentityProps/page.mdx) \\| [BaseFilterable](../../../interfaces/auth.BaseFilterable/page.mdx)&#60;[FilterableProviderIdentityProps](../../../interfaces/auth.FilterableProviderIdentityProps/page.mdx)&#62;)[]","description":"An array of filters to apply on the entity, where each item in the array is joined with an \"or\" condition.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"id","type":"`string`[]","description":"The IDs to filter the provider identity by.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"entity_id","tLine truncated
+
+## Returns
+
+<TypeList types={[{"name":"Promise","type":"Promise&#60;[ProviderIdentityDTO](../../../interfaces/auth.ProviderIdentityDTO/page.mdx)[]&#62;","optional":false,"defaultValue":"","description":"The list of provider identities.","expandable":false,"children":[{"name":"ProviderIdentityDTO[]","type":"[ProviderIdentityDTO](../../../interfaces/auth.ProviderIdentityDTO/page.mdx)[]","optional":false,"defaultValue":"","description":"","expandable":false,"children":[{"name":"ProviderIdentityDTO","type":"`object`","description":"The provider identity details.","optional":false,"defaultValue":"","expandable":false,"children":[]}]}]}]} expandUrl="https://docs.medusajs.com/v2/advanced-development/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="listProviderIdentities"/>
@@ -0,0 +1,19 @@
+---
+displayed_sidebar: authReference
+slug: /references/auth/register
+sidebar_label: register
+---
+
+import { TypeList } from "docs-ui"
+
+# register - Auth Module Reference
+
+This documentation provides a reference to the `register` method. This belongs to the Auth Module.
+
+## Parameters
+
+<TypeList types={[{"name":"provider","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"providerData","type":"[AuthenticationInput](../../../interfaces/auth.AuthenticationInput/page.mdx)","description":"","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"url","type":"`string`","description":"URL of the incoming authentication request.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"headers","type":"`Record<string, string>`","description":"Headers of incoming authentication request.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"query","type":"`Record<string, string>`","description":"Query params of the incoming authentication request.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"body","type":"`Record<string, string>`","description":"Body of the incoming authentication request.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"protocol","type":"`string`","description":"Protocol of the incoming authentication request (For example, `https`).","optional":true,"defaultValue":"","expandable":false,"children":[]}]}]} expandUrl="https://docs.medusajs.com/v2/advanced-development/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="register"/>
+
+## Returns
+
+<TypeList types={[{"name":"Promise","type":"Promise&#60;[AuthenticationResponse](../../../interfaces/auth.AuthenticationResponse/page.mdx)&#62;","optional":false,"defaultValue":"","description":"","expandable":false,"children":[{"name":"AuthenticationResponse","type":"[AuthenticationResponse](../../../interfaces/auth.AuthenticationResponse/page.mdx)","optional":false,"defaultValue":"","description":"The details of the authentication response.","expandable":false,"children":[{"name":"success","type":"`boolean`","description":"Whether the authentication was successful.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"authIdentity","type":"[AuthIdentityDTO](../../../interfaces/auth.AuthIdentityDTO/page.mdx)","description":"The authenticated user's details.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"id","type":"`string`","description":"The ID of the auth identity.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"provider_identities","type":"[ProviderIdentityDTO](../../../interfaces/auth.ProviderIdentityDTO/page.mdx)[]","description":"The list of provider identities linked to the auth identity.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"app_metadata","type":"`Record<string, unknown>`","description":"Holds information related to the actor IDs tied to the auth identity.","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"error","type":"`string`","description":"If an error occurs during the authentication process,\nwhether within the Auth Module or a third-party provider,\nthe error message is set in this field.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"location","type":"`string`","description":"The URL to redirect to for further authentication action\nwith a third-party provider. This takes precedence before\nthe `success` field.\n\nSo, after checking that authentication is successful,\nyou should check whether this field is defined and, if so, redirect to the\nspecified location.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"successRedirectUrl","type":"`string`","description":"Some authentication providers support redirecting to a specified URL on\nsuccess. In those cases, the URL to redirect to is set in this field.\n\nSo, if `success` is true, there's no `location` set, and this field\nis set, you can redirect to this URL.","optional":true,"defaultValue":"","expandable":false,"children":[]}]}]}]} expandUrl="https://docs.medusajs.com/v2/advanced-development/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="register"/>
@@ -0,0 +1,27 @@
+---
+displayed_sidebar: authReference
+slug: /references/auth/retrieveProviderIdentity
+sidebar_label: retrieveProviderIdentity
+---
+
+import { TypeList } from "docs-ui"
+
+# retrieveProviderIdentity - Auth Module Reference
+
+This documentation provides a reference to the `retrieveProviderIdentity` method. This belongs to the Auth Module.
+
+This method retrieves a provider identity by its ID.
+
+## Example
+
+```ts
+const providerIdentity = await authModuleService.retrieveProviderIdentity("provider_123")
+```
+
+## Parameters
+
+<TypeList types={[{"name":"id","type":"`string`","description":"The ID of the provider identity.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"config","type":"[FindConfig](../../../interfaces/auth.FindConfig/page.mdx)&#60;[ProviderIdentityDTO](../../../interfaces/auth.ProviderIdentityDTO/page.mdx)&#62;","description":"The configurations determining how the provider identity is retrieved. Its properties, such as `select` or `relations`, accept the\nattributes or relations associated with a provider identity.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"select","type":"(`string` \\| keyof Entity)[]","description":"An array of strings, each being attribute names of the entity to retrieve in the result.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"skip","type":"`null` \\| `number`","description":"A number indicating the number of records to skip before retrieving the results.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"take","type":"`null` \\| `number`","description":"A number indicating the number of records to return in the result.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"relations","type":"`string`[]","description":"An array of strings, each being relation names of the entity to retrieve in the result.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"order","type":"`object`","description":"An object used to specify how to sort the returned records. Its keys are the names of attributes of the entity, and a key's value can either be `ASC`\nto sort retrieved records in an ascending order, or `DESC` to sort retrieved records in a descending order.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"withDeleted","type":"`boolean`","description":"A boolean indicating whether deleted records should also be retrieved as part of the result. This only works if the entity extends the\n`SoftDeletableEntity` class.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"filters","type":"`Record<string, any>`","description":"Enable ORM specific defined filters","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"options","type":"`Record<string, any>`","description":"Enable ORM specific defined options","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"sharedContext","type":"[Context](../../../interfaces/auth.Context/page.mdx)","description":"A context used to share resources, such as transaction manager, between the application and the module.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"transactionManager","type":"TManager","description":"An instance of a transaction manager of type `TManager`, which is a typed parameter passed to the context to specify the type of the `transactionManager`.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"manager","type":"TManager","description":"An instance of a manager, typically an entity manager, of type `TManager`, which is a typed parameter passed to the context to specify the type of the `manager`.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"isolationLevel","type":"`string`","description":"A string indicating the isolation level of the context. Possible values are `READ UNCOMMITTED`, `READ COMMITTED`, `REPEATABLE READ`, or `SERIALIZABLE`.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"enableNestedTransactions","type":"`boolean`","description":"A boolean value indicating whether nested transactions are enabled.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"eventGroupId","type":"`string`","description":"A string indicating the ID of the group to aggregate the events to be emitted at a later point.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"transactionId","type":"`string`","description":"A string indicating the ID of the current transaction.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"messageAggregator","type":"[IMessageAggregator](../../../interfaces/auth.IMessageAggregator/page.mdx)","description":"An instance of a message aggregator, which is used to aggregate messages to be emitted at a later point.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"requestId","type":"`string`","description":"A string indicating the ID of the current request.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"idempotencyKey","type":"`string`","description":"A string indicating the idempotencyKey of the current workflow execution.","optional":true,"defaultValue":"","expandable":false,"children":[]}]}]} expandUrl="https://docs.medusajs.com/v2/advanced-development/data-models/manage-relationships#retrieve-records-of-relation" sectioLine truncated
+
+## Returns
+
+<TypeList types={[{"name":"Promise","type":"Promise&#60;[ProviderIdentityDTO](../../../interfaces/auth.ProviderIdentityDTO/page.mdx)&#62;","optional":false,"defaultValue":"","description":"The retrieved provider identity.","expandable":false,"children":[{"name":"ProviderIdentityDTO","type":"[ProviderIdentityDTO](../../../interfaces/auth.ProviderIdentityDTO/page.mdx)","optional":false,"defaultValue":"","description":"The provider identity details.","expandable":false,"children":[{"name":"id","type":"`string`","description":"The ID of the provider identity.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"provider","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"entity_id","type":"`string`","description":"The user's identifier. For example, when using the `emailpass`\nprovider, the `entity_id` would be the user's email.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"auth_identity","type":"[AuthIdentityDTO](../../../interfaces/auth.AuthIdentityDTO/page.mdx)","description":"The auth identity linked to the provider identity.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"id","type":"`string`","description":"The ID of the auth identity.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"provider_identities","type":"[ProviderIdentityDTO](../../../interfaces/auth.ProviderIdentityDTO/page.mdx)[]","description":"The list of provider identities linked to the auth identity.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"app_metadata","type":"`Record<string, unknown>`","description":"Holds information related to the actor IDs tied to the auth identity.","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"provider_metadata","type":"`Record<string, unknown>`","description":"Holds custom data related to the provider in key-value pairs.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"user_metadata","type":"`Record<string, unknown>`","description":"Holds custom data related to the user in key-value pairs.","optional":true,"defaultValue":"","expandable":false,"children":[]}]}]}]} expandUrl="https://docs.medusajs.com/v2/advanced-development/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="retrieveProviderIdentity"/>
@@ -0,0 +1,53 @@
+---
+displayed_sidebar: authReference
+slug: /references/auth/updateProviderIdentites
+sidebar_label: updateProviderIdentites
+---
+
+import { TypeList } from "docs-ui"
+
+# updateProviderIdentites - Auth Module Reference
+
+This documentation provides a reference to the `updateProviderIdentites` method. This belongs to the Auth Module.
+
+## updateProviderIdentites(data, sharedContext?): Promise&#60;[ProviderIdentityDTO](../../../interfaces/auth.ProviderIdentityDTO/page.mdx)[]&#62;
+
+This method updates existing provider identities.
+
+### Example
+
+```ts
+const providerIdentities = await authModuleService.updateProviderIdentities([
+  {
+    id: "provider_123",
+  },
+])
+```
+
+### Parameters
+
+<TypeList types={[{"name":"data","type":"[UpdateProviderIdentityDTO](../../../interfaces/auth.UpdateProviderIdentityDTO/page.mdx)[]","description":"The attributes to update in the provider identities.","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"id","type":"`string`","description":"The ID of the provider identity.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"entity_id","type":"`string`","description":"The user's identifier. For example, when using the `emailpass`\nprovider, the `entity_id` would be the user's email.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"provider_metadata","type":"`Record<string, unknown>`","description":"Holds custom data related to the provider in key-value pairs.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"user_metadata","type":"`Record<string, unknown>`","description":"Holds custom data related to the user in key-value pairs.","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"sharedContext","type":"[Context](../../../interfaces/auth.Context/page.mdx)","description":"A context used to share resources, such as transaction manager, between the application and the module.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"transactionManager","type":"TManager","description":"An instance of a transaction manager of type `TManager`, which is a typed parameter passed to the context to specify the type of the `transactionManager`.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"manager","type":"TManager","description":"An instance of a manager, typically an entity manager, of type `TManager`, which is a typed parameter passed to the context to specify the type of the `manager`.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"isolationLevel","type":"`string`","description":"A string indicating the isolation level of the context. Possible values are `READ UNCOMMITTED`, `READ COMMITTED`, `REPEATABLE READ`, or `SERIALIZABLE`.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"enableNestedTransactions","type":"`boolean`","description":"A boolean value indicating whether nested transactions are enabled.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"eventGroupId","type":"`string`","description":"A string indicating the ID of the group to aggregate the events to be emitted at a later point.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"transactionId","type":"`string`","description":"A string indicating the ID of the current transaction.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"messageAggregator","type":"[IMessageAggregator](../../../interfaces/auth.IMessageAggregator/page.mdx)","description":"An instance of a message aggregator, which is used to aggregate messages to be emitted at a later point.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"requestId","type":"`string`","description":"A string indicating the ID of the current request.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"idempotencyKey","type":"`string`","description":"A string indicating the idempotencyKey of the current workflow execution.","optional":true,"defaultValue":"","expandable":false,"children":[]}]}]} expandUrl="https://docs.medusajs.com/v2/advanced-development/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="updateProviderIdentites"/>
+
+### Returns
+
+<TypeList types={[{"name":"Promise","type":"Promise&#60;[ProviderIdentityDTO](../../../interfaces/auth.ProviderIdentityDTO/page.mdx)[]&#62;","optional":false,"defaultValue":"","description":"The updated provider identities.","expandable":false,"children":[{"name":"ProviderIdentityDTO[]","type":"[ProviderIdentityDTO](../../../interfaces/auth.ProviderIdentityDTO/page.mdx)[]","optional":false,"defaultValue":"","description":"","expandable":false,"children":[{"name":"ProviderIdentityDTO","type":"`object`","description":"The provider identity details.","optional":false,"defaultValue":"","expandable":false,"children":[]}]}]}]} expandUrl="https://docs.medusajs.com/v2/advanced-development/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="updateProviderIdentites"/>
+
+## updateProviderIdentites(data, sharedContext?): Promise&#60;[ProviderIdentityDTO](../../../interfaces/auth.ProviderIdentityDTO/page.mdx)&#62;
+
+This method updates an existing provider identity.
+
+### Example
+
+```ts
+const providerIdentity = await authModuleService.updateProviderIdentites({
+  id: "provider_123",
+})
+```
+
+### Parameters
+
+<TypeList types={[{"name":"data","type":"[UpdateProviderIdentityDTO](../../../interfaces/auth.UpdateProviderIdentityDTO/page.mdx)","description":"The attributes to update in the provider identity.","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"id","type":"`string`","description":"The ID of the provider identity.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"entity_id","type":"`string`","description":"The user's identifier. For example, when using the `emailpass`\nprovider, the `entity_id` would be the user's email.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"provider_metadata","type":"`Record<string, unknown>`","description":"Holds custom data related to the provider in key-value pairs.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"user_metadata","type":"`Record<string, unknown>`","description":"Holds custom data related to the user in key-value pairs.","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"sharedContext","type":"[Context](../../../interfaces/auth.Context/page.mdx)","description":"A context used to share resources, such as transaction manager, between the application and the module.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"transactionManager","type":"TManager","description":"An instance of a transaction manager of type `TManager`, which is a typed parameter passed to the context to specify the type of the `transactionManager`.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"manager","type":"TManager","description":"An instance of a manager, typically an entity manager, of type `TManager`, which is a typed parameter passed to the context to specify the type of the `manager`.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"isolationLevel","type":"`string`","description":"A string indicating the isolation level of the context. Possible values are `READ UNCOMMITTED`, `READ COMMITTED`, `REPEATABLE READ`, or `SERIALIZABLE`.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"enableNestedTransactions","type":"`boolean`","description":"A boolean value indicating whether nested transactions are enabled.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"eventGroupId","type":"`string`","description":"A string indicating the ID of the group to aggregate the events to be emitted at a later point.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"transactionId","type":"`string`","description":"A string indicating the ID of the current transaction.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"messageAggregator","type":"[IMessageAggregator](../../../interfaces/auth.IMessageAggregator/page.mdx)","description":"An instance of a message aggregator, which is used to aggregate messages to be emitted at a later point.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"requestId","type":"`string`","description":"A string indicating the ID of the current request.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"idempotencyKey","type":"`string`","description":"A string indicating the idempotencyKey of the current workflow execution.","optional":true,"defaultValue":"","expandable":false,"children":[]}]}]} expandUrl="https://docs.medusajs.com/v2/advanced-development/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="updateProviderIdentites"/>
+
+### Returns
+
+<TypeList types={[{"name":"Promise","type":"Promise&#60;[ProviderIdentityDTO](../../../interfaces/auth.ProviderIdentityDTO/page.mdx)&#62;","optional":false,"defaultValue":"","description":"The updated provider identity.","expandable":false,"children":[{"name":"ProviderIdentityDTO","type":"[ProviderIdentityDTO](../../../interfaces/auth.ProviderIdentityDTO/page.mdx)","optional":false,"defaultValue":"","description":"The provider identity details.","expandable":false,"children":[{"name":"id","type":"`string`","description":"The ID of the provider identity.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"provider","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"entity_id","type":"`string`","description":"The user's identifier. For example, when using the `emailpass`\nprovider, the `entity_id` would be the user's email.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"auth_identity","type":"[AuthIdentityDTO](../../../interfaces/auth.AuthIdentityDTO/page.mdx)","description":"The auth identity linked to the provider identity.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"id","type":"`string`","description":"The ID of the auth identity.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"provider_identities","type":"[ProviderIdentityDTO](../../../interfaces/auth.ProviderIdentityDTO/page.mdx)[]","description":"The list of provider identities linked to the auth identity.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"app_metadata","type":"`Record<string, unknown>`","description":"Holds information related to the actor IDs tied to the auth identity.","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"provider_metadata","type":"`Record<string, unknown>`","description":"Holds custom data related to the provider in key-value pairs.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"user_metadata","type":"`Record<string, unknown>`","description":"Holds custom data related to the user in key-value pairs.","optional":true,"defaultValue":"","expandable":false,"children":[]}]}]}]} expandUrl="https://docs.medusajs.com/v2/advanced-development/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="updateProviderIdentites"/>
@@ -8,4 +8,4 @@ import { TypeList } from "docs-ui"

 The filters to apply on the retrieved auth identity.

-<TypeList types={[{"name":"id","type":"`string`[]","description":"The IDs to filter the auth identity by.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"provider_identities","type":"`object`","description":"The provider identities to filter the auth identity by.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"entity_id","type":"`string`","description":"Filter the provider identities by the ID of the provider identity ID they are linked to.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"provider","type":"`string`","description":"Filter the provider identities by the provider handle.","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"$and","type":"([FilterableAuthIdentityProps](page.mdx) \\| [BaseFilterable](../auth.BaseFilterable/page.mdx)&#60;[FilterableAuthIdentityProps](page.mdx)&#62;)[]","description":"An array of filters to apply on the entity, where each item in the array is joined with an \"and\" condition.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"id","type":"`string`[]","description":"The IDs to filter the auth identity by.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"provider_identities","type":"`object`","description":"The provider identities to filter the auth identity by.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"entity_id","type":"`string`","description":"Filter the provider identities by the ID of the provider identity ID they are linked to.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"provider","type":"`string`","description":"Filter the provider identities by the provider handle.","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"$and","type":"([FilterableAuthIdentityProps](page.mdx) \\| [BaseFilterable](../auth.BaseFilterable/page.mdx)&#60;[FilterableAuthIdentityProps](page.mdx)&#62;)[]","description":"An array of filters to apply on the entity, where each item in the array is joined with an \"and\" condition.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"id","type":"`string`[]","description":"The IDs to filter the auth identity by.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"provider_identities","type":"`object`","description":"The provider identities to filter the auth identity by.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$and","type":"([FilterableAuthIdentityProps](page.mdx) \\| [BaseFilterable](../auth.BaseFilterable/page.mdx)&#60;[FilterableAuthIdentityProps](page.mdx)&#62;)[]","description":"An array of filters to apply on the entity, where each item in the array is joined with an \"and\" condition.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$or","type":"([FilterableAuthIdentityProps](page.mdx) \\| [BaseFilterable](../auth.BaseFilterable/page.mdx)&#60;[FilterableAuthIdentityProps](page.mdx)&#62;)[]","description":"An array of filters to apply on the entity, where each item in the array is joined with an \"or\" condition.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$and","type":"([BaseFilterable](../auth.BaseFilterable/page.mdx)&#60;T&#62; \\| T)[]","description":"An array of filters to apply on the entity, where each item in the array is joined with an \"and\" condition.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$or","type":"([BaseFilterable](../auth.BaseFilterable/page.mdx)&#60;T&#62; \\| T)[]","description":"An array of filters to apply on the entity, where each item in the array is joined with an \"or\" condition.","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"$or","type":"([FilterableAuthIdentityProps](page.mdx) \\| [BaseFilterable](../auth.BaseFilterable/page.mdx)&#60;[FilterableAuthIdentityProps](page.mdx)&#62;)[]","description":"An array of filters to apply on the entity, where each item in the array is joined with an \"or\" condition.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"id","type":"`string`[]","description":"The IDs to filter the auth identity by.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"provider_identities","type":"`object`","description":"The provider identities to filter the auth identity by.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$and","type":"([FilterableAuthIdentityProps](page.mdx) \\| [BaseFilterable](../auth.BaseFilterable/page.mdx)&#60;[FilterableAuthIdentityProps](page.mdx)&#62;)[]","description":"An array of filters to apply on the entity, where each item in the array is joined with an \"and\" condition.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$or","type":"([FilterableAuthIdentityProps](page.mdx) \\| [BaseFiLine truncated
+<TypeList types={[{"name":"id","type":"`string`[]","description":"The IDs to filter the auth identity by.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"provider_identities","type":"`object`","description":"The provider identities to filter the auth identity by.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"entity_id","type":"`string`","description":"Filter the provider identities by the ID of the provider identity ID they are linked to.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"provider","type":"`string`","description":"Filter the provider identities by the provider handle.","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"app_metadata","type":"`Record<string, unknown>`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$and","type":"([FilterableAuthIdentityProps](page.mdx) \\| [BaseFilterable](../auth.BaseFilterable/page.mdx)&#60;[FilterableAuthIdentityProps](page.mdx)&#62;)[]","description":"An array of filters to apply on the entity, where each item in the array is joined with an \"and\" condition.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"id","type":"`string`[]","description":"The IDs to filter the auth identity by.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"provider_identities","type":"`object`","description":"The provider identities to filter the auth identity by.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"entity_id","type":"`string`","description":"Filter the provider identities by the ID of the provider identity ID they are linked to.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"provider","type":"`string`","description":"Filter the provider identities by the provider handle.","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"app_metadata","type":"`Record<string, unknown>`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$and","type":"([FilterableAuthIdentityProps](page.mdx) \\| [BaseFilterable](../auth.BaseFilterable/page.mdx)&#60;[FilterableAuthIdentityProps](page.mdx)&#62;)[]","description":"An array of filters to apply on the entity, where each item in the array is joined with an \"and\" condition.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"id","type":"`string`[]","description":"The IDs to filter the auth identity by.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"provider_identities","type":"`object`","description":"The provider identities to filter the auth identity by.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"app_metadata","type":"`Record<string, unknown>`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$and","type":"([FilterableAuthIdentityProps](page.mdx) \\| [BaseFilterable](../auth.BaseFilterable/page.mdx)&#60;[FilterableAuthIdentityProps](page.mdx)&#62;)[]","description":"An array of filters to apply on the entity, where each item in the array is joined with an \"and\" condition.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$or","type":"([FilterableAuthIdentityProps](page.mdx) \\| [BaseFilterable](../auth.BaseFilterable/page.mdx)&#60;[FilterableAuthIdentityProps](page.mdx)&#62;)[]","description":"An array of filters to apply on the entity, where each item in the array is joined with an \"or\" condition.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$and","type":"([BaseFilterable](../auth.BaseFilterable/page.mdx)&#60;T&#62; \\| T)[]","description":"An array of filters to apply on the entity, where each item in the array is joined with an \"and\" condition.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$or","type":"([BaseFilterable](../auth.BaseFilterable/page.mdx)&#60;T&#62; \\| T)[]","description":"An array of filters to apply on the entity, where each item in the array is joined with an \"or\" condition.","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"$or","type":"([FilterableAuthIdentityProps](page.mdx) \\| [BaseFilterable](../auth.BaseFilterable/page.mdx)&#60;[FilterableAuthIdentityProps](page.mdx)&#62;)[]","description":"An array of filters to apply on the entity, where each item in the array is joined with an \"or\" condition.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"id","type":"`string`[]","description":"The IDs to filter the auth identity by.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"provider_identities","type":"`object`","description":"The provider identities to filter the auth identity by.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"aLine truncated
@@ -0,0 +1,11 @@
+---
+displayed_sidebar: authReference
+---
+
+import { TypeList } from "docs-ui"
+
+# FilterableProviderIdentityProps
+
+An object used to allow specifying flexible queries with and/or conditions.
+
+<TypeList types={[{"name":"id","type":"`string`[]","description":"The IDs to filter the provider identity by.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"entity_id","type":"`string`","description":"Filter the provider identities by the ID of the provider identity they are linked to.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"provider","type":"`string`","description":"The provider handle to filter the provider identity by.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"provider_metadata","type":"`Record<string, unknown>`","description":"Holds custom data related to the provider in key-value pairs.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"user_metadata","type":"`Record<string, unknown>`","description":"Holds custom data related to the user in key-value pairs.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$and","type":"([FilterableProviderIdentityProps](page.mdx) \\| [BaseFilterable](../auth.BaseFilterable/page.mdx)&#60;[FilterableProviderIdentityProps](page.mdx)&#62;)[]","description":"An array of filters to apply on the entity, where each item in the array is joined with an \"and\" condition.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"id","type":"`string`[]","description":"The IDs to filter the provider identity by.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"entity_id","type":"`string`","description":"Filter the provider identities by the ID of the provider identity they are linked to.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"provider","type":"`string`","description":"The provider handle to filter the provider identity by.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"provider_metadata","type":"`Record<string, unknown>`","description":"Holds custom data related to the provider in key-value pairs.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"user_metadata","type":"`Record<string, unknown>`","description":"Holds custom data related to the user in key-value pairs.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$and","type":"([FilterableProviderIdentityProps](page.mdx) \\| [BaseFilterable](../auth.BaseFilterable/page.mdx)&#60;[FilterableProviderIdentityProps](page.mdx)&#62;)[]","description":"An array of filters to apply on the entity, where each item in the array is joined with an \"and\" condition.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"id","type":"`string`[]","description":"The IDs to filter the provider identity by.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"entity_id","type":"`string`","description":"Filter the provider identities by the ID of the provider identity they are linked to.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"provider","type":"`string`","description":"The provider handle to filter the provider identity by.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"provider_metadata","type":"`Record<string, unknown>`","description":"Holds custom data related to the provider in key-value pairs.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"user_metadata","type":"`Record<string, unknown>`","description":"Holds custom data related to the user in key-value pairs.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$and","type":"([FilterableProviderIdentityProps](page.mdx) \\| [BaseFilterable](../auth.BaseFilterable/page.mdx)&#60;[FilterableProviderIdentityProps](page.mdx)&#62;)[]","description":"An array of filters to apply on the entity, where each item in the array is joined with an \"and\" condition.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$or","type":"([FilterableProviderIdentityProps](page.mdx) \\| [BaseFilterable](../auth.BaseFilterable/page.mdx)&#60;[FilterableProviderIdentityProps](page.mdx)&#62;)[]","description":"An array of filters to apply on the entity, where each item in the array is joined with an \"or\" condition.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$and","type":"([BaseFilterable](../auth.BaseFilterable/page.mdx)&#60;T&#62; \\| T)[]","description":"An array of filters to apply on the entity, where each item in the array is joined with an \"and\" condition.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"$or","type":"([BaseFilterable](../auth.BaseFilterable/page.mdx)&#60;T&#62; \\| T)[]","description":"An array of filters to apply on the entity, where each item in the array is joined with an \"or\" condition.","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"$or","type":"([FilterableProviderIdentityPLine truncated
@@ -14,6 +14,7 @@ The main service interface for the Auth Module.
 ## Methods

 - [authenticate](../../IAuthModuleService/methods/auth.IAuthModuleService.authenticate/page.mdx)
+- [register](../../IAuthModuleService/methods/auth.IAuthModuleService.register/page.mdx)
 - [validateCallback](../../IAuthModuleService/methods/auth.IAuthModuleService.validateCallback/page.mdx)
 - [retrieveAuthIdentity](../../IAuthModuleService/methods/auth.IAuthModuleService.retrieveAuthIdentity/page.mdx)
 - [listAuthIdentities](../../IAuthModuleService/methods/auth.IAuthModuleService.listAuthIdentities/page.mdx)
@@ -21,3 +22,8 @@ The main service interface for the Auth Module.
 - [createAuthIdentities](../../IAuthModuleService/methods/auth.IAuthModuleService.createAuthIdentities/page.mdx)
 - [updateAuthIdentites](../../IAuthModuleService/methods/auth.IAuthModuleService.updateAuthIdentites/page.mdx)
 - [deleteAuthIdentities](../../IAuthModuleService/methods/auth.IAuthModuleService.deleteAuthIdentities/page.mdx)
+- [retrieveProviderIdentity](../../IAuthModuleService/methods/auth.IAuthModuleService.retrieveProviderIdentity/page.mdx)
+- [listProviderIdentities](../../IAuthModuleService/methods/auth.IAuthModuleService.listProviderIdentities/page.mdx)
+- [createProviderIdentities](../../IAuthModuleService/methods/auth.IAuthModuleService.createProviderIdentities/page.mdx)
+- [updateProviderIdentites](../../IAuthModuleService/methods/auth.IAuthModuleService.updateProviderIdentites/page.mdx)
+- [deleteProviderIdentities](../../IAuthModuleService/methods/auth.IAuthModuleService.deleteProviderIdentities/page.mdx)
@@ -0,0 +1,11 @@
+---
+displayed_sidebar: authReference
+---
+
+import { TypeList } from "docs-ui"
+
+# UpdateProviderIdentityDTO
+
+The provider identity to be created.
+
+<TypeList types={[{"name":"id","type":"`string`","description":"The ID of the provider identity.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"entity_id","type":"`string`","description":"The user's identifier. For example, when using the `emailpass`\nprovider, the `entity_id` would be the user's email.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"provider_metadata","type":"`Record<string, unknown>`","description":"Holds custom data related to the provider in key-value pairs.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"user_metadata","type":"`Record<string, unknown>`","description":"Holds custom data related to the user in key-value pairs.","optional":true,"defaultValue":"","expandable":false,"children":[]}]} expandUrl="https://docs.medusajs.com/v2/advanced-development/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="UpdateProviderIdentityDTO"/>