Identities

Retrieve an identity

Retrieves detailed information about a specific identity using their identity ID or external ID from your system.

get/v2/identities/{id}

Path parameters

idstring required

Identity ID to retrieve.

Query parameters

include_metricsboolean

Include aggregate usage metrics on the returned identity.

include_budgetboolean

When true, embed the identity-scoped budget (config and limits only, no live usage) on the returned record.

Response

OK

Changes

Changed in 8 of the 257 revisions of this API.36

    • removed the optional property identity/allOf[Identity]/budget/allOf[Budget]/scope/allOf[BudgetScope]/factory from the response with the 200 status

      response-optional-property-removed

    This revision also has 39 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

    • added the optional property identity/allOf[Identity]/budget/allOf[Budget]/scope/allOf[BudgetScope]/factory to the response with the 200 status

      response-optional-property-added

    This revision also has 9 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

    • added the optional property identity/allOf[Identity]/budget/allOf[Budget]/alerts to the response with the 200 status

      response-optional-property-added

    This revision also has 6 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

    • removed the optional property identity/allOf[Identity]/budget/allOf[Budget]/alerts from the response with the 200 status

      response-optional-property-removed

    This revision also has 49 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

    • added the optional property identity/allOf[Identity]/budget/allOf[Budget]/alerts to the response with the 200 status

      response-optional-property-added

    This revision also has 6 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

    • removed the optional property identity/allOf[Identity]/budget/allOf[Budget]/alerts from the response with the 200 status

      response-optional-property-removed

    This revision also has 49 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

    • added the optional property identity/allOf[Identity]/budget/allOf[Budget]/alerts to the response with the 200 status

      response-optional-property-added

    • added the new optional query request parameter include_budget

      new-optional-request-parameter

    • added the optional property identity/allOf[Identity]/budget to the response with the 200 status

      response-optional-property-added

Of the 257 revisions, 71 have no diff computed.