# Get an Identity

This endpoint retrieves the details of the requested Identity of a given Twin. It can be called only for Identities owned by the account of the requesting user.

Method Path Operation*
GET /twins/{twin}/identities/{identity} get_twin_identity

*

In order for a user to perform the "get_twin_identity" operation, the "get_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
{twin}
required
string path Twin UUID.
{identity}
required
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.

# Response

Attribute Type Description
visibility string Visibility of the Identity. If the value is null, the Identity is private. Private Identities are only visible to users of the account which owns the Identity. If the value is not null, the Identity is public. Public Identities are also visible to users of other accounts if the visibility rule held in the "visibility" attribute evaluates to True.
validity_ts timestamp Time at which the Identity expires. Measured in seconds (to three decimal places) that have elapsed since the Unix epoch (opens new window). If the value is null, the Identity does not expire.
updated_ts timestamp Time at which the Identity was last updated. Measured in seconds (to three decimal places) that have elapsed since the Unix epoch (opens new window).
creation_certificate object
Certificate generated automatically by the system upon creation of the Identity. The creation certificate cannot be modified after it has been generated.
Attribute Type Description
identity string 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}.
creator string Account UUID of the account creating the Identity.
created_ts timestamp Time at which the Identity was created. Measured in seconds (to three decimal places) that have elapsed since the Unix epoch (opens new window).

# Status codes

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