snapshot of https://github.com/ory/kratos.git (master, 2026-09-15; blobs > 131072B omitted)

cmd/identities/get.go

@@ -0,0 +1,116 @@
+// Copyright © 2023 Ory Corp
+// SPDX-License-Identifier: Apache-2.0
+
+package identities
+
+import (
+	"fmt"
+
+	kratos "github.com/ory/kratos/pkg/httpclient"
+	"github.com/ory/x/cmdx"
+	"github.com/ory/x/stringsx"
+
+	"github.com/ory/kratos/pkg/clihelpers"
+
+	"github.com/spf13/cobra"
+
+	"github.com/ory/kratos/cmd/cliclient"
+)
+
+const (
+	FlagIncludeCreds = "include-credentials"
+	FlagExternalID   = "external-id"
+)
+
+func NewGetCmd() *cobra.Command {
+	cmd := &cobra.Command{
+		Use:   "get",
+		Short: "Get resources",
+	}
+	cmd.AddCommand(NewGetIdentityCmd())
+	cliclient.RegisterClientFlags(cmd.PersistentFlags())
+	cmdx.RegisterFormatFlags(cmd.PersistentFlags())
+	return cmd
+}
+
+func NewGetIdentityCmd() *cobra.Command {
+	var (
+		includeCreds []string
+		byExternalID bool
+	)
+
+	cmd := &cobra.Command{
+		Use:   "identity [id-1] [id-2] [id-n]",
+		Short: "Get one or more identities by their ID(s)",
+		Long: fmt.Sprintf(`This command gets all the details about an identity. To get an identity by some selector, e.g. the recovery email address, use the list command in combination with jq.
+
+Use the --%s flag to look up identities by their external ID instead of their Ory-internal ID.
+
+%s`, FlagExternalID, clihelpers.WarningJQIsComplicated),
+		Example: `To get the identities with the recovery email address at the domain "ory.sh", run:
+
+	{{ .CommandPath }} $({{ .Root.Name }} ls identities --format json | jq -r 'map(select(.recovery_addresses[].value | endswith("@ory.sh"))) | .[].id')
+
+To get an identity by its external ID, run:
+
+	{{ .CommandPath }} --external-id customer-12345`,
+		Args: cobra.MinimumNArgs(1),
+		RunE: func(cmd *cobra.Command, args []string) error {
+			c, err := cliclient.NewClient(cmd)
+			if err != nil {
+				return err
+			}
+
+			// we check includeCreds argument is valid
+			for _, opt := range includeCreds {
+				e := stringsx.SwitchExact(opt)
+				if !e.AddCase("oidc") {
+					cmd.PrintErrln(`You have to put a valid value of credentials type to be included, try --help for details.`)
+					return cmdx.FailSilently(cmd)
+				}
+			}
+
+			identities := make([]kratos.Identity, 0, len(args))
+			failed := make(map[string]error)
+			for _, id := range args {
+				var identity *kratos.Identity
+				if byExternalID {
+					identity, _, err = c.IdentityAPI.
+						GetIdentityByExternalID(cmd.Context(), id).
+						IncludeCredential(includeCreds).
+						Execute()
+				} else {
+					identity, _, err = c.IdentityAPI.
+						GetIdentity(cmd.Context(), id).
+						IncludeCredential(includeCreds).
+						Execute()
+				}
+
+				if clihelpers.SDKError(err) != nil {
+					failed[id] = cmdx.PrintOpenAPIError(cmd, err)
+					continue
+				}
+
+				identities = append(identities, *identity)
+			}
+
+			if len(identities) == 1 {
+				cmdx.PrintRow(cmd, (*outputIdentity)(&identities[0]))
+			} else if len(identities) > 1 {
+				cmdx.PrintTable(cmd, &outputIdentityCollection{Identities: identities, includePageToken: false})
+			}
+			cmdx.PrintErrors(cmd, failed)
+
+			if len(failed) != 0 {
+				return cmdx.FailSilently(cmd)
+			}
+			return nil
+		},
+	}
+
+	flags := cmd.Flags()
+	// include credential flag to add third party tokens in returned data
+	flags.StringArrayVarP(&includeCreds, FlagIncludeCreds, "i", []string{}, `Include third party tokens (only "oidc" supported) `)
+	flags.BoolVar(&byExternalID, FlagExternalID, false, "Treat the provided ID(s) as external IDs and look up the identities by their external ID instead of their Ory-internal ID.")
+	return cmd
+}