# Resolve Twin Identity

This endpoint returns a list of all Twin UUIDs of Twins to which a given Identity is attached if the Twins are visible to the calling user.

When resolving an Identity, the user can provide additional context for the resolution process to narrow down their search.


The search might result costly and time-consuming if you do not narrow down the context of your search. We highly recommend that you keep the context of the search as narrow as possible or to cache the response. You can narrow down the context by using the query string parameter context.

Method Path Operation*
GET /resolve/{identity} resolve_twin_identity


In order for a user to perform the "resolve_twin_identity" operation, the "resolve_twin_identity" permission must be included in the list of allowed actions in the statement of the user's role.

# Request

Parameter Type In Description
string path User-defined ID for the Identity. It must match the regular expression(opens new window) ^[A-Za-z_][0-9A-Za-z_]{0,7}#[0-9A-Za-z_=+-]{1,128}$. It is stored in the "identity" field of the creation certificate of the Identity.
optional *
string, value is {account}, personal, or system; DEFAULT=personal query string As it is possible to use the same Identity to group several Twins, you can provide additional context to narrow down the list of Identities to be included in the search:
- {account}: Account UUID. Identities owned by the specified account and visible to the requesting user.
- personal: Identities owned by the account of the requesting user.
- system: Identities in the entire Trusted Twin system visible to the requesting user.


The "context" parameter is optional and does not need to be included in the request body when resolving Identities. If it is not included in the request, its default value is used.

# Response

The response returns a list of Twin UUIDs that the Identity is attached to. In our example, the Identity "RFID#be144bdc-0f6d-4a00-4091-1a6d793cbbbb" is attached only to one Twin. The Twin UUID of the Twin is "700e3a9c-ed26-4f8a-82ed-c0e4237fc600".

# Status codes

Requests to this endpoint result in generic status codes. For a comprehensive list of status codes, please consult the Status codes section.

Was this article helpful?