Get Twin Identities

This endpoint retrieves a list of Identities of the given Twin.

Method	Path	Operation*
GET	/twins/{twin}/identities	get_twin_identities

*

In order for a user to perform the "get_twin_identities" operation, the "get_twin_identities" 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.
show_foreign optional *	boolean/string: if boolean DEFAULT=False, string value must be {account} (account UUID)	query string	Shows public Identities owned by different accounts if the Identities are visible to the requesting user. Public Identities are visible to users of the account that owns the Identity and also visible to users of other accounts if the visibility rule held in the "visibility" attribute evaluates to True.
show_personal optional *	boolean, DEFAULT=True	query string	Shows Identities that are attached to the account of the requesting user.
show_expired optional *	boolean, DEFAULT=False	query string	Additional filter for personal Identities: shows personal Identities where validity_ts <= now (current time).
show_valid optional *	boolean, DEFAULT=True	query string	Additional filter for personal Identities: shows personal Identities where validity_ts > now (current time).
show_public optional *	boolean, DEFAULT=True	query string	Additional filter for personal Identities: shows personal Identities that are public. Public Identities are visible to users of the account that owns the Identity and also visible to users of other accounts if the visibility rule held in the "visibility" attribute evaluates to True.
show_private optional *	boolean, DEFAULT=True	query string	Additional filter for personal Identities: shows personal Identities that are private. Private Identities are only visible to users of the account that owns the Identity.

*

The show_expired, show_valid, show_foreign, show_personal, show_public, and show_private parameters are optional and do not need to be included in the request. If they are not included in the request, their default values are used.

Response

The response returns a list of Identities for the requested Twin grouped by account UUIDs.

Attribute	Type	Description
accounts	dictionary	Dictionary containing accounts with Identities: - key: Account UUID - value: Identity.

Identity

Attribute	Type	Description
{identity}	dictionary	Dictionary containing a given Identity with attributes: - key: Identity name. String matching the regular expression(opens new window) ^[A-Za-z_][0-9A-Za-z_]{0,7}#[0-9A-Za-z_=+-]{1,128}$. - value: Identity attributes.

Identity attributes

Attribute	Type	Description
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.
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).
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).

Status codes

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