Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs: document batch create identities #1505

Closed
wants to merge 1 commit into from
Closed
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
80 changes: 80 additions & 0 deletions docs/migrate-to-ory/import-identities.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,80 @@
---
id: import-identities
title: Bulk-import identities from other providers
sidebar_label: Bulk-import identities
slug: bulk-import-identities
---

# Bulk-import identities from other providers

To import multiple identities into Ory Identites, use the
[Identity Import API](https://www.ory.sh/docs/reference/api#tag/identity/operation/batchPatchIdentities).

A maximum of 2000 identities can be created in a single request. If you need to import more identities, you can split the import
into multiple requests.

The endpoint accepts a JSON array of identities, each of which must have a `create` propery which holds the identity that should
be created. Optionally, you can specify a `patch_id` property which will be returned in the response. This can be used to
correlate the response with the patch.

The following example shows how to import two identities. It will create two identities with the email addresses `[email protected]`
and `[email protected]` and the passwords `foopassword` and `barpassword` respectively.

```bash
curl --location --request PATCH 'https://${YOUR_PROJECT_SLUG}.projects.oryapis.com/admin/identities' \
--header 'Authorization: Bearer ${YOUR_ORY_ACCESS_TOKEN}' \
--header 'Content-Type: application/json' \
--data-raw '{
"identities": [
{
"create": {
"credentials": {
"password": {
"config": {
"password": "foopassword"
}
}
},
"state": "active",
"traits": {
"email": "[email protected]"
},
"schema_id": "preset://email"
}
},
{
"create": {
"credentials": {
"password": {
"config": {
"password": "barpassword"
}
}
},
"state": "active",
"traits": {
"email": "[email protected]"
},
"schema_id": "preset://email"
}
}
]
}'
```

The service will respond with the two identity IDs created:

```json
{
"identities": [
{
"action": "create",
"identity": "55f93ea4-09ff-4273-8b88-082cc70d6d44"
},
{
"action": "create",
"identity": "f70c9b29-4790-4330-90dc-920db16a4b85"
}
]
}
```
1 change: 1 addition & 0 deletions src/sidebar.js
Original file line number Diff line number Diff line change
Expand Up @@ -304,6 +304,7 @@ module.exports = {
items: [
"hydra/self-hosted/migrating-from-mitreid",
"migrate-to-ory/auth0",
"migrate-to-ory/import-identities",
],
},
{
Expand Down
Loading