Skip to content
Merged
Show file tree
Hide file tree
Changes from 13 commits
Commits
Show all changes
17 commits
Select commit Hold shift + click to select a range
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
92 changes: 92 additions & 0 deletions docs/identities/model/identity-schema-selection.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,92 @@
---
id: identity-schema-selection
title: Identity schema selection
---

```mdx-code-block
import Tabs from "@theme/Tabs"
import TabItem from "@theme/TabItem"
```

# Identity schema selection for self-service registration and login flows

Ory Kratos now supports selecting an identity schema during registration and login self-service flows by specifying a
query parameter. This gives administrators more control over which schemas are used and allows multi-tenant or multi-profile
setups with distinct identity models.


## Overview

- Users or integrators can choose which schema to use by appending the `identity_schema` query parameter when initiating
registration or login flows.
- Only schemas explicitly marked as selectable via `selfservice_selectable: true` in the configuration will be accepted.
- If no schema is selected, the default schema is used (this is the existing behavior).

## How to use

### Registration example

####Browser flow:####

```
GET /self-service/registration/browser?identity_schema=schema-a
```

**API flow:**
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

see above


```
GET /self-service/registration/api?identity_schema=schema-a
```

### Login Example

**Browser flow:**
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

see above


```
GET /self-service/login/browser?identity_schema=schema-a
```

**API flow:**
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

see above


```
GET /self-service/login/api?identity_schema=schema-a
```

## Configuration

You must define which schemas are available for self-service selection by using the `selfservice_selectable` flag in your identity
schema configuration.

### Example configuration

```yaml
identity:
default_schema_id: default
schemas:
- id: default
url: file://./schemas/default.schema.json
selfservice_selectable: true

- id: schema-a
url: file://./schemas/schema-a.schema.json
selfservice_selectable: true

- id: schema-internal
url: file://./schemas/internal.schema.json
selfservice_selectable: false # This one cannot be selected by end users
```

Only schemas where `selfservice_selectable: true` will be selectable via the `identity_schema` parameter.

## Behavior Summary

- If a schema is listed and marked as selectable, it can be used in registration/login.
- If a schema is not listed or not marked as selectable, it cannot be used via query param.
- If no `identity_schema` is passed, the default schema (`default_schema_id`) is used.

## Migration notes

- This feature is non-breaking. Existing flows using the default schema are unaffected.
- You only need to update configuration if you want to expose multiple schemas for selection.
- Schemas used internally can remain non-selectable, for example for admin or machine users.

1 change: 1 addition & 0 deletions src/sidebar.ts
Original file line number Diff line number Diff line change
Expand Up @@ -448,6 +448,7 @@ const kratos: SidebarItemsConfig = [
"kratos/manage-identities/managing-users-identities-metadata",
"identities/model/manage-identity-schema",
"kratos/manage-identities/customize-identity-schema",
"identities/model/identity-schema-selection",
"kratos/manage-identities/best-practices",
],
},
Expand Down
Loading