ORory
identity

Create an Identity

Changed on

Create an identity. This endpoint can also be used to import credentials for instance passwords, social sign in configurations or multifactor methods.

post/admin/identities

Request

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

Request body

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.

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.

state'active' | 'inactive'

State is the identity's state. active StateActive inactive StateInactive

traitsobject required

Traits represent an identity's traits. The identity is able to create, modify, and delete traits in a self-service manner. The input will always be validated against the JSON Schema defined in schema_url.

Example request

{
  "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"
    }
  ],
  "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"
    }
  ]
}

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

  • 5f08e5827b5eRevision changes
    • breaking

      the response property // became optional for the status

    • warning

      removed the request property ///

    • info

      added the new optional request property /////

    • info

      added the new optional request property /

    • info

      added the new optional request property

    • info

      the request property // became optional

    • info

      added the optional property to the response with the status

  • df2fe8db7397Revision changes
    • warning

      added the new saml enum value to the // response property for the response status

    • info

      added the new optional request property ////

    • info

      added the new optional request property /////

    • info

      added the new optional request property ///

    • info

      added the new optional request property