Hanzo
OpenapiIam

Returns one person's session in one application — when it began and which…

Returns one person's session in one application — when it began and which browsers or devices are still carrying it.

POST /v1/iam/sessions/get

Addresshttps://api.hanzo.ai/v1/iam/sessions/get
MethodPOST
OperationgetSession
AuthAuthorization: Bearer $HANZO_API_KEY

Returns one person's session in one application — when it began and which browsers or devices are still carrying it.

Request

3 fields, body application/json (required).

FieldInTypeRequiredDescription
applicationbodystringyes
namebodystringyes
ownerbodystringyes

Response

StatusBodyMeaning
200iam.Sessionok

200 body — 10 fields.

FieldInTypeAlwaysDescription
applicationbodystring
createdAtbodystring (date-time)
createdTimebodystring
deletedbodyboolean
exclusiveSigninbodybooleanExclusiveSignin is a transient control flag (v1 xorm:"-"): a caller sets it on a create to collapse SessionId down to the single incoming cookie instead of…
idbodystring
namebodystring
ownerbodystring
sessionIdbodystring[]
updatedAtbodystring (date-time)

Failure carries the platform error shape — see Errors.

Examples

hanzo iam sessions get \
  --application <application> \
  --name <name> \
  --owner <owner>

IAM API · All Hanzo APIs · Interactive reference

How is this guide?

On this page