ORorq-ai
Identities

Create an identity

Changed on

Creates a new identity with a unique external_id. If an identity with the same external_id already exists, the operation will fail.

post/v2/identities

Request

  • Base URL
    https://my.orq.ai
  • URL
    https://my.orq.ai/v2/identities
  • Auth
    HTTP bearer

Request body

external_idstring required

Customer-provided stable identifier for this identity. Must be unique within the workspace.

display_namestring

Human-readable display name for the identity.

emailstring

Email address associated with the identity.

avatar_urlstring

URL of the identity avatar image.

tagsstring[]

Free-form labels used to organize and filter identities.

metadataobject

Custom JSON metadata stored with the identity.

Response

Identity created successfully.

Changes

  • 0b4e519a544fRevision changes
    • info

      added the non-success response with the status

    • info

      removed the BUDGET_ALERT_DIMENSION_UNSPECIFIED enum value from the //////////// response property for the response status

    • info

      removed the BUDGET_PERIOD_UNSPECIFIED enum value from the /////////// response property for the response status

  • 732aed62833aRevision changes
    • warning

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

    • warning

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

    • info

      removed the non-success response with the status