Ory

https://www.ory.com/docs
Admin
Ory is a comprehensive identity and access management platform providing authentication,...
Tokens:871,871
Snippets:9,710
Trust Score:9.5
Update:2 months ago
Show doc for...
Tokens:
Raw
### Clone and setup Next.js example application

Source: https://www.ory.com/docs/getting-started/integrate-auth/auth-js

Commands to clone the repository, install dependencies, and initialize environment variables.

```bash
git clone https://github.com/ory/next-auth-example.git  

cd next-auth-example  

npm install  

cp .env.local.example .env.local  

npx auth secret  
```

--------------------------------

### Start the Keto example environment

Source: https://www.ory.com/docs/oel/keto/quickstart

Commands to clone the repository and launch the example environment using either Docker Compose or a local bash script.

```bash
# clone the repository if you don't have it yet  

git clone git@github.com:ory/keto.git && cd keto  

  

# Alternatively, you can use 'https' to clone if ssh cloning gives permission denied error. (Configure ssh keys in github to resolve the issue.)  

git clone https://github.com/ory/keto.git && cd keto  

  
docker-compose -f contrib/cat-videos-example/docker-compose.yml up  

# or  

./contrib/cat-videos-example/up.sh  

  

# output: all initially created relationships  

  

# NAMESPACE       OBJECT          RELATION NAME   SUBJECT  

# videos          /cats/1.mp4     owner           videos:/cats#owner  

# videos          /cats/1.mp4     view            videos:/cats/1.mp4#owner  

# videos          /cats/1.mp4     view            *  

# videos          /cats/2.mp4     owner           videos:/cats#owner  

# videos          /cats/2.mp4     view            videos:/cats/2.mp4#owner  

# videos          /cats           owner           cat lady  

# videos          /cats           view            videos:/cats#owner
```

--------------------------------

### Clone Repository and Start Example

Source: https://www.ory.com/docs/oss/keto/quickstart

Clone the Ory Keto repository and start the video sharing example using Docker Compose or a bash script. This sets up the necessary services and initializes relationships.

```bash
# clone the repository if you don't have it yet  
git clone git@github.com:ory/keto.git && cd keto  

# Alternatively, you can use 'https' to clone if ssh cloning gives permission denied error. (Configure ssh keys in github to resolve the issue.)  
git clone https://github.com/ory/keto.git && cd keto  

docker-compose -f contrib/cat-videos-example/docker-compose.yml up  
# or  
./contrib/cat-videos-example/up.sh  

# output: all initially created relationships  

# NAMESPACE       OBJECT          RELATION NAME   SUBJECT  

# videos          /cats/1.mp4     owner           videos:/cats#owner  

# videos          /cats/1.mp4     view            videos:/cats/1.mp4#owner  

# videos          /cats/1.mp4     view            *  

# videos          /cats/2.mp4     owner           videos:/cats#owner  

# videos          /cats/2.mp4     view            videos:/cats/2.mp4#owner  

# videos          /cats           owner           cat lady  

# videos          /cats           view            videos:/cats#owner  
```

--------------------------------

### Start Ory Proxy Example

Source: https://www.ory.com/docs/cli/ory-proxy

A simple command to start the proxy for a local application.

```bash

ory proxy http://localhost:3000  

  



```

--------------------------------

### Run the Integration

Source: https://www.ory.com/docs/integrates-with/identity-verification/lexisnexis

Commands to install dependencies and start the integration server.

```bash
cd webhook/  

cp .env.example .env  

npm install  

npm start              # runs `tsx server.ts`  
```

--------------------------------

### Run the Webhook Service

Source: https://www.ory.com/docs/integrates-with/crm/zoho-crm

Commands to install dependencies and start the webhook server.

```bash
cd webhook/  

cp .env.example .env  

npm install  

npm start              # runs `tsx server.ts`
```

--------------------------------

### Example Usage

Source: https://www.ory.com/docs/cli/ory-perform-authorization-code

A basic example of running the command with required client credentials.

```bash
ory perform authorization-code --client-id ... --client-secret ...
```

--------------------------------

### Run the React Native application

Source: https://www.ory.com/docs/getting-started/integrate-auth/react-native

Example output showing the command to start the iOS simulator and the resulting Metro Bundler URL.

```bash
npm run ios  

  

>@ory/expo-login-registration-template@v0.5.4-alpha.1.pre.5 ios  

>expo start --ios  

  

Starting project at /Users/ory/Desktop/kratos-selfservice-ui-react-native  

Developer tools running on http://localhost:19002  

Starting Metro Bundler  

  

# This is the exact URL you must provide in the simulator. Starts with 'exp://'.  

Opening exp://192.168.1.144:19000 on iPhone 13 mini
```

--------------------------------

### talos proxy command examples

Source: https://www.ory.com/docs/talos/reference/cli/talos-proxy

Common command-line invocations for starting the proxy with different configurations.

```bash
talos proxy --upstream http://talos:4420
```

```bash
talos proxy --upstream http://talos:4420 --listen :9090 --cache-ttl 5m
```

```bash
talos proxy --upstream http://talos:4420 --trust-x-forwarded-host
```

--------------------------------

### Example Execution

Source: https://www.ory.com/docs/cli/ory-perform-device-code

A basic example of how to invoke the command with a client ID.

```bash
ory perform device-code --client-id ...
```

--------------------------------

### Install PostgreSQL

Source: https://www.ory.com/docs/kratos/guides/deploy-kratos-example

Install the PostgreSQL server and switch to the postgres user.

```bash
sudo apt install postgresql postgresql-contrib -y  

sudo -i -u postgres  
```

--------------------------------

### Start systemd service

Source: https://www.ory.com/docs/kratos/guides/deploy-kratos-example

Start the Kratos service immediately.

```bash
systemctl start kratos.service  
```

--------------------------------

### Migration Examples

Source: https://www.ory.com/docs/talos/reference/cli/talos-migrate-up

Examples of running migrations for different database types using flags or environment variables.

```bash
# SQLite  

talos migrate up --database "sqlite3://./data/talos.db"  

  

# PostgreSQL (commercial)  

export DB_DSN="postgres://user:pass@localhost:5432/talos?sslmode=disable"  

talos migrate up  

  

# MySQL (commercial)  

talos migrate up --database "mysql://user:pass@tcp(localhost:3306)/talos"  

  

# CockroachDB (commercial)  

talos migrate up --database "cockroach://user:pass@localhost:5432/talos?sslmode=disable"
```

--------------------------------

### Import Examples

Source: https://www.ory.com/docs/cli/ory-import-jwk

Examples showing how to import JWKs from files with specific formats or usage settings.

```bash
ory import jwk my-set ./path/to/jwk.json ./path/to/jwk-2.json --format json
```

```bash
ory import jwk my-set ./path/to/rsa.key ./path/to/rsa.pub --use enc
```

--------------------------------

### Install Ory SDK via Setuptools

Source: https://www.ory.com/docs/keto/sdk/python

Install the package using the setup.py script.

```bash
python setup.py install --user  

```

--------------------------------

### Example Usage

Source: https://www.ory.com/docs/hydra/cli/hydra-introspect-token

An example of how to introspect a token with a specific project ID.

```bash
hydra introspect token AYjcyMzY3ZDhiNmJkNTY --project 32197be3-8e57-4009-becd-9d38dbde129c
```

--------------------------------

### Simple Tunnel Example

Source: https://www.ory.com/docs/cli/ory-tunnel

Minimal example for running the tunnel.

```bash
ory tunnel http://localhost:3000
```

--------------------------------

### Update project examples

Source: https://www.ory.com/docs/cli/ory-update-project

Examples of updating a project using file paths and formatting the output.

```bash
$ ory update project ecaaa3cb-0730-4ee8-a6df-9553cdfeef89 \
	--name "my updated name" \
	--file /path/to/config.json \
	--file /path/to/config.yml \
	--file https://example.org/config.yaml \
	--file base64://<json>

ID		ecaaa3cb-0730-4ee8-a6df-9553cdfeef89
SLUG	good-wright-t7kzy3vugf
STATE	running
NAME	Example Project

$ ory update project ecaaa3cb-0730-4ee8-a6df-9553cdfeef89 \
	--name "my updated name" \
	--file /path/to/config.json \
	--format json-pretty

{
  "name": "my updated name",
  "identity": {
	"services": {
	  "config": {
		"courier": {
		  "smtp": {
			"from_name": "..."
		  }
		  // ...
		}
	  }
	}
  }
}
```

--------------------------------

### Install Dependencies

Source: https://www.ory.com/docs/getting-started/oauth2-openid/add-oauth2-openid-connect-nodejs-expressjs

Commands to initialize the Node.js project and install required packages.

```bash
mkdir example  

cd example  

npm init -y  

npm install express-openid-connect express
```

--------------------------------

### Example talos serve command

Source: https://www.ory.com/docs/talos/reference/cli/talos-serve

A simple execution example of the serve command.

```bash
talos serve
```

--------------------------------

### Initialize Sample Application

Source: https://www.ory.com/docs/hydra/guides/custom-ui-oauth2

Commands to clone the repository, install dependencies, and prepare the environment for the sample application.

```bash
git clone git@github.com:ory/hydra-login-consent-node.git  

cd hydra-login-consent-node/  

npm i  
```

```bash
export ORY_PAT=ORY_API_KEY # API Key copied from the Ory Console, 'ory_pat' prefix included.  

export HYDRA_ADMIN_URL=SDK_CONFIGURATION_URL  # Found in the 'Connect' section of the Ory Console.  
```

```bash
npm start  
```

--------------------------------

### Download Quickstart Configuration

Source: https://www.ory.com/docs/hydra/self-hosted/deploy-hydra-example

Downloads the default Ory Hydra quickstart configuration file.

```bash
cd ../config
wget https://raw.githubusercontent.com/ory/hydra/<version-you-want>/contrib/quickstart/5-min/hydra.yml
```

--------------------------------

### Run quickstart with alternative databases

Source: https://www.ory.com/docs/kratos/quickstart

Commands to launch the quickstart environment using PostgreSQL, CockroachDB, or MySQL.

```bash
docker compose -f quickstart.yml -f quickstart-standalone.yml -f quickstart-postgres.yml up --build --force-recreate
```

```bash
docker compose -f quickstart.yml -f quickstart-standalone.yml -f quickstart-crdb.yml up --build --force-recreate
```

```bash
docker compose -f quickstart.yml -f quickstart-standalone.yml -f quickstart-mysql.yml up --build --force-recreate
```

--------------------------------

### Run Ory Hydra with HSM using Docker

Source: https://www.ory.com/docs/hydra/self-hosted/hsm-support

Starts a quickstart Docker container that sets up SoftHSM, builds, and runs Ory Hydra with HSM configuration enabled. Ensure Docker and Docker Compose are installed.

```bash
docker-compose -f quickstart-hsm.yml up --build
```

--------------------------------

### Quickstart configuration file path

Source: https://www.ory.com/docs/kratos/quickstart

Reference to the location of the simplified configuration file used in the tutorial.

```text
contrib/quickstart/kratos/email-password/kratos.yml
```

--------------------------------

### Install Ory SDK

Source: https://www.ory.com/docs/getting-started/integrate-auth/go

Command to install the Ory client library for Go.

```bash
go get github.com/ory/client-go@master  
```

--------------------------------

### SCrypt Hashing Example

Source: https://www.ory.com/docs/kratos/manage-identities/import-user-accounts-identities

Format and example for importing SCrypt hashed passwords.

```text
$scrypt$ln=<cost>,r=<block>,p=<parrelization>$<salt>$<hash>
```

```text
$scrypt$ln=16384,r=8,p=1$ZtQva9xCHzlSELH/mA7Kj5KjH2tCrkbwYzdxknkL0QQ=$pnTcXKaWVT+FwFDdk3vO1K0J7ZgOxdSU1tCJNYmn8zI=
```

--------------------------------

### Example of a fully-defined route

Source: https://www.ory.com/docs/oss/guidelines/rest-api-guidelines

A complete example showing how to document a route with metadata, security, and response definitions.

```go
// swagger:route GET /admin/identities identities listIdentities  

//  

// # List Identities  

//  

// Lists all identities. Does not support search at the moment.  

//  

// Learn how identities work in [Ory Kratos' User And Identity Model Documentation](https://www.ory.com/docs/next/kratos/concepts/identity-user-model).  

//  

//	Produces:  

//	- application/json  

//  

//	Schemes: http, https  

//  

//	Security:  

//	  oryAccessToken:  

//  

//	Responses:  

//	  200: identityList  

//	  default: jsonError  
```

--------------------------------

### Get OAuth 2.0 Client Name using JSON output and jq

Source: https://www.ory.com/docs/hydra/cli/hydra-get-oauth2-client

This example demonstrates how to fetch an OAuth 2.0 client's details in JSON format and then use jq to extract only the client's name. Ensure you have jq installed and replace '<your-client-id>' with an actual client ID.

```bash
hydra get oauth2-client <your-client-id> --format json | jq -r '.client_name'
```

--------------------------------

### Download quickstart configuration

Source: https://www.ory.com/docs/kratos/guides/deploy-kratos-example

Fetches the default identity schema and configuration files.

```bash
cd ../config  

wget https://raw.githubusercontent.com/ory/kratos/<version-you-want>/contrib/quickstart/kratos/email-password/identity.schema.json  

wget https://raw.githubusercontent.com/ory/kratos/<version-you-want>/contrib/quickstart/kratos/email-password/kratos.yml  
```

--------------------------------

### Set Up Environment Variables

Source: https://www.ory.com/docs/polis/install

Copy the example environment file to create a new .env file for local configuration.

```bash
cp .env.example .env  
```

--------------------------------

### Create installation directories

Source: https://www.ory.com/docs/kratos/guides/deploy-kratos-example

Sets up the required directory structure for binaries and configuration files.

```bash
mkdir /opt/kratos/{bin,config}  
```

--------------------------------

### Install Node.js 16 and Dependencies

Source: https://www.ory.com/docs/hydra/self-hosted/deploy-hydra-example

Installs Node.js version 16.x, npm, jq, and unzip on a Ubuntu system using NodeSource setup script.

```bash
curl -sL https://deb.nodesource.com/setup_16.x -o /tmp/nodesource_setup.sh
```

```bash
bash /tmp/nodesource_setup.sh
```

```bash
apt-get install nodejs npm jq unzip
```

--------------------------------

### Project configuration JSON example

Source: https://www.ory.com/docs/cli/ory-update-project

Example structure for the project configuration payload.

```json
{

  "name": "my updated name",

  "identity": {

	"services": {

	  "config": {

		"courier": {

		  "smtp": {

			"from_name": "..."

		  }

		  // ...

		}

	  }

	}

  }

}
```

--------------------------------

### Example execution with credentials

Source: https://www.ory.com/docs/cli/ory-perform-client-credentials

A template showing how to provide the client ID and secret as arguments.

```bash
ory perform client-credentials --client-id ... --client-secret
```

--------------------------------

### PBKDF2 Hashing Example

Source: https://www.ory.com/docs/kratos/manage-identities/import-user-accounts-identities

Format and example for importing PBKDF2 hashed passwords.

```text
$pbkdf2-<algorithm>$i=<iteration>,l=<length>$<salt>$<hash>
```

```text
$pbkdf2-sha256$i=100000,l=32$1jP+5Zxpxgtee/iPxGgOz0RfE9/KJuDElP1ley4VxXc$QJxzfvdbHYBpydCbHoFg3GJEqMFULwskiuqiJctoYpI
```

--------------------------------

### Verify Kratos installation

Source: https://www.ory.com/docs/oss/kratos/install

Run the help command to confirm the binary is correctly installed and accessible.

```bash
kratos help  
```

--------------------------------

### Kratos configuration file

Source: https://www.ory.com/docs/oss/kratos/quickstarts/quickstart

The simplified configuration file used for the quickstart tutorial.

```yaml
version: v0.13.0  

  
dsn: memory  

  
serve:  
  public:  
    base_url: http://127.0.0.1:4433/  
    cors:  
      enabled: true  
  admin:  
    base_url: http://kratos:4434/  
  
selfservice:  
  default_browser_return_url: http://127.0.0.1:4455/welcome  
  allowed_return_urls:  
    - http://127.0.0.1:4455  
    - http://localhost:19006/Callback  
    - exp://localhost:8081/--/Callback  
  
  methods:  
    password:  
      enabled: true  
    totp:  
      config:  
        issuer: Kratos  
      enabled: true  
    lookup_secret:  
      enabled: true  
    link:  
      enabled: true  
    code:  
      enabled: true  
  
  flows:  
    error:  
      ui_url: http://127.0.0.1:4455/error  
  
    settings:  
      ui_url: http://127.0.0.1:4455/settings  
      privileged_session_max_age: 15m  
      required_aal: highest_available  
  
    recovery:  
      enabled: true  
      ui_url: http://127.0.0.1:4455/recovery  
      use: code  
  
    verification:  
      enabled: true  
      ui_url: http://127.0.0.1:4455/verification  
      use: code  
      after:  
        default_browser_return_url: http://127.0.0.1:4455/welcome  
  
    logout:  
      after:  
        default_browser_return_url: http://127.0.0.1:4455/login  
  
    login:  
      ui_url: http://127.0.0.1:4455/login  
      lifespan: 10m  
  
    registration:  
      lifespan: 10m  
      ui_url: http://127.0.0.1:4455/registration  
      after:  
        password:  
          hooks:  
            - hook: session  
            - hook: show_verification_ui  
  
log:  
  level: debug  
  format: text  
  leak_sensitive_values: true  
  
secrets:  
  cookie:  
    - PLEASE-CHANGE-ME-I-AM-VERY-INSECURE  
  cipher:  
    - 32-LONG-SECRET-NOT-SECURE-AT-ALL  
  
ciphers:  
  algorithm: xchacha20-poly1305  
  
hashers:  
  algorithm: bcrypt  
  bcrypt:  
    cost: 8  
  
identity:  
  default_schema_id: default  
  schemas:  
    - id: default  
      url: file:///etc/config/kratos/identity.schema.json  
  
courier:  
  smtp:  
    connection_uri: smtps://test:test@mailslurper:1025/?skip_ssl_verify=true  
  
feature_flags:  
  use_continue_with_transitions: true  
```

--------------------------------

### Create a project

Source: https://www.ory.com/docs/guides/manage-project-via-api

Initialize a new project with specified environment and region settings.

```bash
curl --location --request POST 'https://api.console.ory.com/projects' \

  --header "Content-Type: application/json" \

  --header "Authorization: Bearer ${WORKSPACE_API_KEY}" \

  --data '{

    "name": "example",

    "environment": "dev",

    "home_region": "us-west",

    "workspace_id": "'"${WORKSPACE_ID}"'"

  }' | jq  


```

--------------------------------

### Get User-Flow Error Response

Source: https://www.ory.com/docs/kratos/reference/api

Example JSON structure returned when querying for user-facing self-service errors.

```json
{
  "created_at": "2019-08-24T14:15:22Z",
  "error": { },
  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  "updated_at": "2019-08-24T14:15:22Z"
}
```

--------------------------------

### Get Identity JSON Schema Response

Source: https://www.ory.com/docs/kratos/reference/api

Example response body for the identity schema retrieval endpoint.

```json
{ }
```

--------------------------------

### Get recovery flow browser response

Source: https://www.ory.com/docs/kratos/bring-your-own-ui/custom-ui-basic-integration

Example JSON response for a browser-based recovery flow initiation.

```json
{

  "id": "fb395045-429b-406b-b7cc-cd878b2d453f",

  "type": "browser",

  "expires_at": "2023-02-08T16:47:37.742765Z",

  "issued_at": "2023-02-08T16:17:37.742765Z",

  "request_url": "https://$PROJECT_SLUG.projects.oryapis.com/self-service/recovery/browser",

  "active": "code",

  "ui": {

    "action": "https://$PROJECT_SLUG.projects.oryapis.com/self-service/recovery?flow=fb395045-429b-406b-b7cc-cd878b2d453f",

    "method": "POST",

    "nodes": [

      {

        "type": "input",

        "group": "default",

        "attributes": {

          "name": "csrf_token",

          "type": "hidden",

          "value": "mNBAW/7SFWLH+G/goy7nBayFlEiDBXjN+55qvL/yfHi7/kRpqEhpD4GBEjhXc2OdenuLCIBje3dsHUqvls+wOw==",

          "required": true,

          "disabled": false,

          "node_type": "input"

        },

        "messages": [],

        "meta": {}

      },

      {

        "type": "input",

        "group": "code",

        "attributes": {

          "name": "email",

          "type": "email",

          "required": true,

          "disabled": false,

          "node_type": "input"

        },

        "messages": [],

        "meta": {

          "label": {

            "id": 1070007,

            "text": "Email",

            "type": "info"

          }

        }

      },

      {

        "type": "input",

        "group": "code",

        "attributes": {

          "name": "method",

          "type": "submit",

          "value": "code",

          "disabled": false,

          "node_type": "input"

        },

        "messages": [],

        "meta": {

          "label": {

            "id": 1070005,

            "text": "Submit",

            "type": "info"

          }

        }

      }

    ]

  },

  "state": "choose_method"

}
```

--------------------------------

### Retrieve Identity Configuration Examples

Source: https://www.ory.com/docs/cli/ory-get-identity-config

Examples showing how to export configuration to a file or output it to the console in specific formats.

```bash
$ ory get identity-config --project ecaaa3cb-0730-4ee8-a6df-9553cdfeef89 --format yaml > identity-config.yaml
```

```bash
$ ory get identity-config --format json   # uses currently selected project

{

  "selfservice": {

	"methods": {

	  "password": { "enabled": false }

	}

	// ...

  }

}
```

--------------------------------

### Example Hydra Configuration in YAML

Source: https://www.ory.com/docs/hydra/self-hosted/kubernetes-helm-chart

An example of a YAML configuration file for Ory Hydra, demonstrating how to set specific configuration values like access token TTL. This file is used with `helm install -f`.

```yaml
# hydra-config.yaml  
  
hydra:  
  config:  
    # example:  
    ttl:  
      access_token: 1h  
    # ...  

```

--------------------------------

### Example of listing clients with pagination

Source: https://www.ory.com/docs/hydra/cli/hydra-list-clients

An example demonstrating how to list clients using pagination parameters like page token and page size.

```bash
hydra ls identities --page-token eyJwYWdlIjoxfQ --page-size 10
```

--------------------------------

### Initialize Go project

Source: https://www.ory.com/docs/getting-started/integrate-auth/go

Commands to create the project directory and initialize the Go module.

```bash
mkdir your-project  

cd your-project  

  

touch main.go handler.go middleware.go index.html  

go mod init github.com/<your-name>/your-project  
```

--------------------------------

### Deploy the Pipedrive Webhook Handler

Source: https://www.ory.com/docs/integrates-with/crm/pipedrive

Commands to install dependencies and start the webhook server after configuring environment variables.

```bash
cd webhook/  

cp .env.example .env  

# Fill ORY_WEBHOOK_SECRET and PIPEDRIVE_API_TOKEN.  

npm install  

npm start  
```

--------------------------------

### Download and Install Pre-built Binary

Source: https://www.ory.com/docs/talos/operate/install

Download, extract, and install the Ory Talos binary manually.

```bash
# Example: Linux AMD64. Replace the version and platform to match your system.  

VERSION=<version-you-want>  

curl -sSL -o talos.tar.gz \

  "https://github.com/ory/talos/releases/download/v${VERSION}/talos_${VERSION}_linux_amd64.tar.gz"  

tar -xzf talos.tar.gz talos  

./talos help  
```

```bash
sudo mv ./talos /usr/local/bin/  

talos help  
```

--------------------------------

### Get recovery flow native API response

Source: https://www.ory.com/docs/kratos/bring-your-own-ui/custom-ui-basic-integration

Example JSON response for a native API recovery flow.

```json
{

  "id": "f456dac9-84ac-4f04-b78e-e6aaf2ccbb0c",

  "type": "api",

  "expires_at": "2023-02-08T17:16:27.372377Z",

  "issued_at": "2023-02-08T16:46:27.372377Z",

  "request_url": "https://$PROJECT_SLUG.projects.oryapis.com/self-service/recovery/api",

  "active": "code",

  "ui": {

    "action": "https://$PROJECT_SLUG.projects.oryapis.com/self-service/recovery?flow=f456dac9-84ac-4f04-b78e-e6aaf2ccbb0c",

    "method": "POST",

    "nodes": [

      {

        "type": "input",

        "group": "default",

        "attributes": {

          "name": "csrf_token",

          "type": "hidden",

          "value": "",

          "required": true,

          "disabled": false,

          "node_type": "input"

        },

        "messages": [],

        "meta": {}

      },

      {

        "type": "input",

        "group": "code",

        "attributes": {

          "name": "email",

          "type": "email",

          "required": true,

          "disabled": false,

          "node_type": "input"

        },

        "messages": [],

        "meta": {

          "label": {

            "id": 1070007,

            "text": "Email",

            "type": "info"

          }

        }

      },

      {

        "type": "input",

        "group": "code",

        "attributes": {

          "name": "method",

          "type": "submit",

          "value": "code",

          "disabled": false,

          "node_type": "input"

        },

        "messages": [],

        "meta": {

          "label": {

            "id": 1070005,

            "text": "Submit",

            "type": "info"

          }

        }

      }

    ]

  },

  "state": "choose_method"

}
```

--------------------------------

### Set Up Local Database Instances

Source: https://www.ory.com/docs/polis/install

Create database instances for local development using Docker. Ensure Docker is installed.

```bash
npm run dev-dbs  
```

--------------------------------

### Service startup logs

Source: https://www.ory.com/docs/kratos/guides/deploy-kratos-example

Example output indicating successful service startup.

```text
INFO[2022-05-10T20:51:56Z] TLS has not been configured for public, skipping  audience=application service_name=Ory Kratos service_version=<version-you-want>  

INFO[2022-05-10T20:51:56Z] Starting the public httpd on: 0.0.0.0:4433    audience=application service_name=Ory Kratos service_version=<version-you-want>  

INFO[2022-05-10T20:51:56Z] TLS has not been configured for admin, skipping  audience=application service_name=Ory Kratos service_version=<version-you-want>  

INFO[2022-05-10T20:51:56Z] Starting the admin httpd on: 0.0.0.0:4434     audience=application service_name=Ory Kratos service_version=<version-you-want>  
```

--------------------------------

### Get Recovery Flow Pseudo-code

Source: https://www.ory.com/docs/reference/openapi/get-recovery-flow

Example demonstrating how to retrieve a recovery flow using the client library in a server-side route.

```javascript
router.get('/recovery', async function (req, res) {  

const flow = await client.getRecoveryFlow(req.header('Cookie'), req.query['flow'])  

  

res.render('recovery', flow)  

})
```

--------------------------------

### Create a JWK example

Source: https://www.ory.com/docs/cli/ory-create-jwk

An example command to create a JWK set with a specific algorithm and usage.

```bash
ory create jwk <my-jwk-set> --alg RS256 --use sig
```

--------------------------------

### Get Login Flow Pseudo-code

Source: https://www.ory.com/docs/reference/openapi/get-login-flow

Example of retrieving a login flow using a client library in a server-side route handler.

```javascript
router.get('/login', async function (req, res) {  

const flow = await client.getLoginFlow(req.header('cookie'), req.query['flow'])  

  

res.render('login', flow)  

})
```

--------------------------------

### Verify Kratos Service Logs

Source: https://www.ory.com/docs/kratos/quickstart

Example output indicating that the Kratos admin and public HTTP servers have started successfully.

```text
kratos_1 | time="2020-01-20T14:52:13Z" level=info msg="Starting the admin httpd on: 0.0.0.0:4434"  

kratos_1 | time="2020-01-20T14:52:13Z" level=info msg="Starting the public httpd on: 0.0.0.0:4433"
```

--------------------------------

### Perform Authorization Code Flow

Source: https://www.ory.com/docs/hydra/self-hosted/quickstart

Starts an example web application to perform the OAuth 2.0 Authorization Code Flow.

```bash
docker compose -f quickstart.yml exec hydra \

    hydra perform authorization-code \

    --client-id $code_client_id \

    --client-secret $code_client_secret \

    --endpoint http://127.0.0.1:4444/ \

    --port 5555 \

    --scope openid --scope offline
```

--------------------------------

### Example project creation response

Source: https://www.ory.com/docs/guides/cli/cli-basics

Shows the output returned after successfully creating a project.

```text
# Example response  
  
Project created successfully!  
ID		b7d8a15d-a783-40e6-40df-7acd60cb2b64  
NAME		My New Project  
ENVIRONMENT	dev  
WORKSPACE	885a2468-c23d-40df-a783-c941387a8701  
SLUG		peaceful-something-4iuafwx2vk  
STATE		running  
```

--------------------------------

### Expand command usage examples

Source: https://www.ory.com/docs/keto/cli/keto-expand

Basic syntax and a concrete example for expanding relations on an object.

```bash
keto expand view Doc:readme
```

```bash
keto expand <relation> <object_namespace>:<object_id> [flags]
```

--------------------------------

### Update Identity Configuration Examples

Source: https://www.ory.com/docs/cli/ory-update-identity-config

Examples showing how to update project configuration using different file sources and output formats.

```bash
$ ory update identity-config --project ecaaa3cb-0730-4ee8-a6df-9553cdfeef89 \

	--file /path/to/config.json \

	--file /path/to/config.yml \

	--file https://example.org/config.yaml \

	--file base64://<json> \

	--format json



{

  "courier": {

	"smtp": {

	  "from_name": "..."

	}

	// ...

  }

}



$ ory update identity-config --project ecaaa3cb-0730-4ee8-a6df-9553cdfeef89 \

	--file /path/to/kratos-config.yaml \

    --format yaml



courier:

  smtp:

    # ...
```

--------------------------------

### Get Identities by Recovery Email Domain

Source: https://www.ory.com/docs/kratos/cli/kratos-identities-get

This example demonstrates how to retrieve identities whose recovery email addresses end with a specific domain ('ory.sh'). It combines 'kratos identities list' with 'jq' to filter and extract the IDs, then uses those IDs with 'kratos identities get'.

```bash
kratos identities get $(kratos identities list --format json | jq -r 'map(select(.recovery_addresses[].value | endswith("@ory.sh"))) | .[].id')
```

--------------------------------

### Clone and Run Ory Kratos with Docker Compose

Source: https://www.ory.com/docs/kratos/quickstart

Commands to clone the repository and start the Kratos services using Docker Compose. Ensure Docker and Git are installed before execution.

```bash
git clone https://github.com/ory/kratos.git  

cd kratos  

git checkout <version-you-want>  

docker compose -f quickstart.yml -f quickstart-standalone.yml up --force-recreate  

# If you have SELinux, run:  

docker compose -f quickstart.yml -f quickstart-selinux.yml -f quickstart-standalone.yml up --force-recreate
```

--------------------------------

### Clean up Quickstart Environment

Source: https://www.ory.com/docs/hydra/self-hosted/quickstart

Stops and removes the Docker containers used in the quickstart to prevent conflicts.

```bash
docker compose -f quickstart.yml kill

docker compose -f quickstart.yml rm -f -v
```

--------------------------------

### GET /sessions

Source: https://www.ory.com/docs/oss/guidelines/rest-api-guidelines

Gets my sessions.

```APIDOC
## GET /sessions

### Description
Gets my sessions.

### Method
GET

### Endpoint
/sessions
```

--------------------------------

### Install Ory Kratos on Linux via script

Source: https://www.ory.com/docs/oss/kratos/install

Download and install the Kratos binary on Linux using the provided installation script.

```bash
bash <(curl https://raw.githubusercontent.com/ory/meta/master/install.sh) -d -b . kratos <version-you-want>  

./kratos help  
```

--------------------------------

### Create Database

Source: https://www.ory.com/docs/kratos/guides/deploy-kratos-example

Initialize the kratos database.

```bash
createdb kratos  
```

--------------------------------

### Create ASP.NET project

Source: https://www.ory.com/docs/getting-started/integrate-auth/dotnet

Commands to initialize a new empty ASP.NET web project.

```bash
mkdir your-project  

cd your-project  

  

dotnet new web  
```

--------------------------------

### GET /identity-schemas

Source: https://www.ory.com/docs/oss/guidelines/rest-api-guidelines

Gets managed identity schemas.

```APIDOC
## GET /identity-schemas

### Description
Gets managed identity schemas.

### Method
GET

### Endpoint
/identity-schemas
```

--------------------------------

### GET /.well-known/identity-meta-schema

Source: https://www.ory.com/docs/oss/guidelines/rest-api-guidelines

Gets the identity meta schema.

```APIDOC
## GET /.well-known/identity-meta-schema

### Description
Gets the identity meta schema.

### Method
GET

### Endpoint
/.well-known/identity-meta-schema
```

--------------------------------

### Update permission configuration examples

Source: https://www.ory.com/docs/cli/ory-update-permission-config

Examples showing how to update project configuration using different file sources and output formats.

```bash
$ ory update permission-config --project ecaaa3cb-0730-4ee8-a6df-9553cdfeef89 \
	--file /path/to/config.json \
	--file /path/to/config.yml \
	--file https://example.org/config.yaml \
	--file base64://<json> \
	--format json

{
  "namespaces": [
    {
      "name": "files",
      "id": 2
	},
    // ...
  ]
}

$ ory update permission-config --project ecaaa3cb-0730-4ee8-a6df-9553cdfeef89 \
	--file /path/to/keto-config.yaml \
    --format yaml

namespaces:
  - name: files
    # ...
```

--------------------------------

### GET /schemas/{id}

Source: https://www.ory.com/docs/oss/guidelines/rest-api-guidelines

Gets an identity schema.

```APIDOC
## GET /schemas/{id}

### Description
Gets an identity schema.

### Method
GET

### Endpoint
/schemas/{id}

### Parameters
#### Path Parameters
- **id** (string) - Required - The schema ID
```

--------------------------------

### Retrieve OAuth2 Configuration Examples

Source: https://www.ory.com/docs/cli/ory-get-oauth2-config

Examples showing how to export configuration to a YAML file or output JSON to the console.

```bash
$ ory get oauth2-config --project ecaaa3cb-0730-4ee8-a6df-9553cdfeef89 --format yaml > oauth2-config.yaml
```

```bash
$ ory get oauth2-config --format json   # uses currently selected project

{
  "oauth2": {
    "client_credentials": {
      "default_grant_allowed_scope": false
    },
    "expose_internal_errors": true,
    "grant": {
      "jwt": {
        "iat_optional": false,
        "jti_optional": false,
        "max_ttl": "720h0m0s"
      }
    }
  },
  // ...
}
```

--------------------------------

### Client Credentials Grant Setup

Source: https://www.ory.com/docs/network/hydra/quickstarts/ory-network-oauth2

Commands to create a client and execute the machine-to-machine flow.

```bash
ory create oauth2-client --project "$PROJECT_ID" \

  --name "Client Credentials Demo" \

  --grant-type client_credentials
```

```bash
client_id="{set to CLIENT ID from output}"  

client_secret="{set to CLIENT SECRET from output}"  
```

```bash
ory perform client-credentials \

  --client-id="$client_id" \

  --client-secret="$client_secret" \

  --project "$PROJECT_ID"
```

--------------------------------

### GET /admin/identities/{id}

Source: https://www.ory.com/docs/oss/guidelines/rest-api-guidelines

Gets an identity by ID.

```APIDOC
## GET /admin/identities/{id}

### Description
Gets an identity by ID.

### Method
GET

### Endpoint
/admin/identities/{id}

### Parameters
#### Path Parameters
- **id** (string) - Required - The identity ID
```

--------------------------------

### Examples of retrieving permission configuration

Source: https://www.ory.com/docs/cli/ory-get-permission-config

Examples showing how to export configuration to a YAML file or output JSON to the console.

```bash
$ ory get permission-config --project ecaaa3cb-0730-4ee8-a6df-9553cdfeef89 --format yaml > permission-config.yaml
```

```bash
$ ory get permission-config --format json   # uses currently selected project

{
  "namespaces": [
    {
      "name": "files",
      "id": 1
	},1
    // ...
  ]
}
```

--------------------------------

### Install Ory Keto on Linux via Bash script

Source: https://www.ory.com/docs/oss/keto/install

Download and install the Ory Keto binary on Linux using the provided installation script.

```bash
bash <(curl https://raw.githubusercontent.com/ory/meta/master/install.sh) -d -b . keto <version-you-want>  

./keto help  
```

--------------------------------

### GET /invites/manage/{project}/project

Source: https://www.ory.com/docs/oss/guidelines/rest-api-guidelines

Gets project invites.

```APIDOC
## GET /invites/manage/{project}/project

### Description
Gets project invites.

### Method
GET

### Endpoint
/invites/manage/{project}/project

### Parameters
#### Path Parameters
- **project** (string) - Required - The project ID
```

--------------------------------

### Run Kratos with configuration file

Source: https://www.ory.com/docs/kratos/guides/docker

Start the container while specifying the location of the configuration file.

```bash
docker run {image-name} serve --config /home/ory/kratos.yml
```

--------------------------------

### GET /oauth2/register/{id}

Source: https://www.ory.com/docs/oss/guidelines/rest-api-guidelines

Gets an OIDC dynamic client.

```APIDOC
## GET /oauth2/register/{id}

### Description
Gets an OIDC dynamic client.

### Method
GET

### Endpoint
/oauth2/register/{id}

### Parameters
#### Path Parameters
- **id** (string) - Required - The client ID
```

--------------------------------

### Example configuration file

Source: https://www.ory.com/docs/guides/cli/config-with-cli

A sample configuration file used to update project settings like the email sender name.

```json
{

  "name": "My Project Name",

  "services": {

    "identity": {

      "config": {

        "courier": {

          "smtp": {

            "from_name": "My Custom E-Mail Name"

          }

        }

      }

    }

  }

}



```

--------------------------------

### Verify Installation

Source: https://www.ory.com/docs/talos/operate/install

Check the installed version of Ory Talos.

```bash
talos --version  
```

--------------------------------

### Example of updating OPL configuration

Source: https://www.ory.com/docs/cli/ory-update-opl

Demonstrates how to specify the configuration file path and the structure of the OPL file.

```bash
$ ory update opl --file /path/to/namespace_config.ts

  

class Example implements Namespace {}
```

--------------------------------

### Install PostgreSQL

Source: https://www.ory.com/docs/hydra/self-hosted/deploy-hydra-example

Installs PostgreSQL and its contrib package on the system.

```bash
sudo apt install postgresql postgresql-contrib
```

--------------------------------

### Install Ory Kratos Go SDK

Source: https://www.ory.com/docs/kratos/self-hosted/go

Command to fetch the Kratos client library.

```bash
go get  github.com/ory/kratos-client-go@<version-you-want>  
```

--------------------------------

### Event Example

Source: https://www.ory.com/docs/actions/live-events

A concrete example of a WebhookSucceeded event payload.

```json
{

  "name": "WebhookSucceeded",

  "version": "1",

  "timestamp": "2025-05-16 11:18:56",

  "eventAttributes": {

    "GeoLocationCity": "Munich",

    "WebhookID": "",

    "WebhookTriggerID": "18093e08-0f72-445f-aacb-151fc777a232"

  }

}
```

--------------------------------

### Verify Binary Installation

Source: https://www.ory.com/docs/oathkeeper/install

Check that the binary is correctly installed and accessible.

```bash
oathkeeper help  
```

--------------------------------

### Command Usage Example

Source: https://www.ory.com/docs/cli/ory-format-jsonnet

Demonstrates the basic syntax for running the format command with file paths and glob patterns.

```bash
ory format jsonnet path/to/files/*.jsonnet [more/files.jsonnet] [supports/**/{foo,bar}.jsonnet] [flags]
```

--------------------------------

### Initialize API Project

Source: https://www.ory.com/docs/getting-started/integrate-auth/vue

Commands to set up a new Node.js project and install required dependencies.

```bash
mkdir api  
cd api  
npm init  
npm i --save @ory/client-fetch express cors
```

--------------------------------

### Create and Import an Example Identity

Source: https://www.ory.com/docs/kratos/cli/kratos-import-identities

This example demonstrates how to create a simple identity JSON file and then import it using `kratos import identities`.

```bash
cat > ./file.json <<EOF
{
    "schema_id": "default",
    "traits": {
        "email": "foo@example.com"
    }
}
EOF

kratos import identities file.json
```

--------------------------------

### Start the Server

Source: https://www.ory.com/docs/talos/operate/install

Launch the Ory Talos server using a configuration file.

```bash
talos serve --config config.yaml  
```

--------------------------------

### Set Cookie Secrets during Helm Install

Source: https://www.ory.com/docs/hydra/self-hosted/kubernetes-helm-chart

Includes setting a cryptographically strong cookie secret during the Helm installation of Ory Hydra. This is an optional addition to the base installation command.

```bash
helm install \
    ...  
    --set 'hydra.config.secrets.cookie=$(LC_ALL=C tr -dc 'A-Za-z0-9' < /dev/urandom | base64 | head -c 32)' \
    ...  
    ory/hydra  

```

--------------------------------

### Install NextAuth.js

Source: https://www.ory.com/docs/polis/guides/frameworks/nextjs

Install the NextAuth.js package to handle authentication in your Next.js application.

```bash
npm i --save next-auth
```

--------------------------------

### Start React development server

Source: https://www.ory.com/docs/getting-started/integrate-auth/react

Command to launch the local development environment.

```bash
npm run dev  
```

--------------------------------

### Install Nginx and Certbot

Source: https://www.ory.com/docs/hydra/self-hosted/deploy-hydra-example

Installs Nginx and Certbot for SSL certificate management.

```bash
apt install nginx certbot python3-certbot-nginx
```

--------------------------------

### Start Go Application

Source: https://www.ory.com/docs/getting-started/integrate-auth/go

Command to execute the Go application locally.

```bash
go run .
```

--------------------------------

### Install Ory SDK

Source: https://www.ory.com/docs/getting-started/integrate-auth/php

Install the Ory client library via Composer.

```bash
composer require ory/client  
```

--------------------------------

### Update OAuth2 Configuration Examples

Source: https://www.ory.com/docs/cli/ory-update-oauth2-config

Examples showing how to update configuration using different file formats and output formats.

```bash
$ ory update oauth2-config --project ecaaa3cb-0730-4ee8-a6df-9553cdfeef89 \
	--file /path/to/config.json \
	--file /path/to/config.yml \
	--file https://example.org/config.yaml \
	--file base64://<json> \
	--format json

{

  "oauth2": {

    "pkce": {

      "enabled": true

    }

  },

  // ...

}

$ ory update oauth2-config --project ecaaa3cb-0730-4ee8-a6df-9553cdfeef89 \
	--file /path/to/keto-config.yaml \
    --format yaml

oauth2:

  pkce:

    enabled: true

# ...
```

--------------------------------

### Initialize Settings Flow

Source: https://www.ory.com/docs/guides/upgrade/sdk-v1

Example showing the transition from v0alpha2 to the frontend API for initializing browser settings flows.

```javascript

  const flow = await ory  

-   .v0alpha2.initializeSelfServiceSettingsFlowForBrowsers()  

+   .frontend.createBrowserSettingsFlow()  

    then(({ data: flow }) => flow)  



```

--------------------------------

### Create Environment Configuration File

Source: https://www.ory.com/docs/getting-started/integrate-auth/flutter-web-redirect

Initialize the .env file in the project root.

```bash
touch .env  
```

--------------------------------

### Install react-intl dependency

Source: https://www.ory.com/docs/elements/guides/internationalization

Install the required react-intl library for internationalization support.

```bash
npm install react-intl  
```

--------------------------------

### Start systemd Service

Source: https://www.ory.com/docs/hydra/self-hosted/deploy-hydra-example

Starts the Ory Hydra service using systemd.

```bash
systemctl start hydra.service
```

--------------------------------

### Run the development server

Source: https://www.ory.com/docs/getting-started/integrate-auth/nextjs-pages-router-quickstart

Start the Next.js development server using the appropriate command for your package manager.

```bash
npm run dev
```

```bash
pnpm dev
```

```bash
yarn dev
```

```bash
bun dev
```

--------------------------------

### Start ExpressJS Server

Source: https://www.ory.com/docs/getting-started/oauth2-openid/add-oauth2-openid-connect-nodejs-expressjs

Commands to set environment variables and start the application.

```bash
export ORY_PROJECT_SLUG="{set to the project slug from output}"  

export OAUTH_CLIENT_ID="{set to the client ID from output}"  

export OAUTH_CLIENT_SECRET="{set to the client secret from output}"  

  

node server.js
```

--------------------------------

### Import identity examples

Source: https://www.ory.com/docs/cli/ory-import-identities

Demonstrates creating an identity file and importing it, or piping the file content directly to the command.

```bash
cat > ./file.json <<EOF  
	{
	    "schema_id": "default",
	    "traits": {
	        "email": "foo@example.com"
	    }
	}
	EOF

	ory import identities file.json
```

```bash
cat file.json | ory import identities
```

--------------------------------

### Import OAuth 2.0 clients from file

Source: https://www.ory.com/docs/cli/ory-import-oauth2-client

Example showing the creation of a JSON file and importing it using the CLI.

```bash
cat > ./file.json <<EOF  

	[  

      {  

	    "grant_types": ["implicit"],  

	    "scope": "openid"  

	  },  

      {  

	    "grant_types": ["authorize_code"],  

	    "scope": "openid"  

	  }  

    ]  

	EOF  

  

	ory import oauth2-client file.json
```

--------------------------------

### Reverse Proxy Request Example

Source: https://www.ory.com/docs/network/oathkeeper/quickstarts

Example of an incoming request to the reverse proxy.

```http
GET /my-service/whatever HTTP/1.1  

Host: oathkeeper-proxy:4455  

Authorization: bearer some-token  

```

--------------------------------

### Firebase SCrypt Example

Source: https://www.ory.com/docs/kratos/manage-identities/import-user-accounts-identities

An example of a valid Firebase SCrypt hash string.

```text
$firescrypt$ln=14,r=8,p=1$sPtDhWcd1MfdAw==$xbSou7FOl6mChCyzpCPIQ7tku7nsQMTFtyOZSXXd7tjBa4NtimOx7v42Gv2SfzPQu1oxM2/k4SsbOu73wlKe1A==$Bw==$YE0dO4bwD4JnJafh6lZZfkp1MtKzuKAXQcDCJNJNyeCHairWHKENOkbh3dzwaCdizzOspwr/FITUVlnOAwPKyw==
```

--------------------------------

### Serve command help options

Source: https://www.ory.com/docs/talos/reference/cli/talos-serve

Displays help information for the serve command.

```bash
-h, --help   help for serve
```

--------------------------------

### Start Kratos Service with Docker

Source: https://www.ory.com/docs/oel/kratos/install

Launch the Kratos service container with configuration mounted from the host.

```bash
docker run \

-p 4433:4433 -p 4434:4434 \

-e DSN=your_database_connection_string \

-v /path/to/config:/etc/config/kratos \

europe-docker.pkg.dev/ory-artifacts/ory-enterprise-kratos/kratos-oel:<image-tag> \

serve all -c /etc/config/kratos/kratos.yaml
```

--------------------------------

### Run Database Migrations

Source: https://www.ory.com/docs/talos/operate/install

Initialize the database schema before starting the server.

```bash
# SQLite (OSS)  

talos migrate up --database "sqlite3://./data/talos.db"  
```

--------------------------------

### Example workspace creation response

Source: https://www.ory.com/docs/guides/cli/cli-basics

Shows the output returned after successfully creating a workspace.

```text
# Example response  
  
Workspace created successfully!  
ID                 885a2468-c23d-40df-a783-c941387a8701  
NAME               My New Workspace  
SUBSCRIPTION PLAN  <none>  
```
Tokens:
Raw