ORory
identity

Get an Identity by its External ID

Changed on

Return an identity by its external ID. You can optionally include credentials (e.g. social sign in connections) in the response by using the include_credential query parameter.

get/admin/identities/by/external/{externalID}

Request

  • Base URL
    / (relative, and the document was published on a file host, not at the API’s origin)
  • URL
    /admin/identities/by/external/{externalID}
  • Auth
    API key in header Authorization

Path parameters

externalIDstring required

ExternalID must be set to the ID of identity you want to get

Query parameters

include_credentialstring[]

Include Credentials in Response

Include any credential, for example password or oidc, in the response. When set to oidc, This will return the initial OAuth 2.0 Access Token, OAuth 2.0 Refresh Token and the OpenID Connect ID Token if available.

Response

identity

created_atstring date-time

CreatedAt is a helper struct field for gobuffalo.pop.

credentialsobject

Credentials represents all credentials that can be used for authenticating this identity.

external_idstring

ExternalID is an optional external ID of the identity. This is used to link the identity to an external system. If set, the external ID must be unique across all identities.

idstring uuid required

ID is the identity's unique identifier.

The Identity ID can not be changed and can not be chosen. This ensures future compatibility and optimization for distributed stores such as CockroachDB.

metadata_adminunknown
metadata_publicunknown
organization_idstring uuid4 nullable
schema_idstring required

SchemaID is the ID of the JSON Schema to be used for validating the identity's traits.

schema_urlstring required

SchemaURL is the URL of the endpoint where the identity's traits schema can be fetched from.

format: url

state'active' | 'inactive'

State is the identity's state.

This value has currently no effect. active StateActive inactive StateInactive

state_changed_atstring date-time
traitsunknown required
updated_atstring date-time

UpdatedAt is a helper struct field for gobuffalo.pop.

Example response

{
  "traits": "",
  "credentials": {
    "key": {
      "updated_at": "2000-01-23T04:56:07.000+00:00",
      "identifiers": [
        "identifiers",
        "identifiers"
      ],
      "created_at": "2000-01-23T04:56:07.000+00:00",
      "type": "password",
      "config": "{}",
      "version": 0
    }
  },
  "state_changed_at": "2000-01-23T04:56:07.000+00:00",
  "created_at": "2000-01-23T04:56:07.000+00:00",
  "external_id": "external_id",
  "recovery_addresses": [
    {
      "updated_at": "2000-01-23T04:56:07.000+00:00",
      "created_at": "2000-01-23T04:56:07.000+00:00",
      "id": "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
      "value": "value",
      "via": "via"
    },
    {
      "updated_at": "2000-01-23T04:56:07.000+00:00",
      "created_at": "2000-01-23T04:56:07.000+00:00",
      "id": "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
      "value": "value",
      "via": "via"
    }
  ],
  "metadata_admin": "",
  "updated_at": "2000-01-23T04:56:07.000+00:00",
  "verifiable_addresses": [
    {
      "updated_at": "2014-01-01T23:28:56.782Z",
      "verified_at": "2000-01-23T04:56:07.000+00:00",
      "verified": true,
      "created_at": "2014-01-01T23:28:56.782Z",
      "id": "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
      "value": "value",
      "status": "status",
      "via": "email"
    },
    {
      "updated_at": "2014-01-01T23:28:56.782Z",
      "verified_at": "2000-01-23T04:56:07.000+00:00",
      "verified": true,
      "created_at": "2014-01-01T23:28:56.782Z",
      "id": "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
      "value": "value",
      "status": "status",
      "via": "email"
    }
  ],
  "organization_id": "organization_id",
  "schema_id": "schema_id",
  "schema_url": "schema_url",
  "id": "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
  "state": "active",
  "metadata_public": ""
}

Changes