Get My User Sessions

Returns a list of a user session for the user agent of the authenticated user. This can be used to switch accounts in the current application.

application/json

application/grpc

application/grpc-web+proto

Request Body required

object

Request Body required

object

Request Body required

object

Responses

• 200
• default

---

A successful response.

application/json

application/grpc

application/grpc-web+proto

Schema

Example (from schema)

---

Schema

result object[]
Array [
sessionId string
agentId string
authState string
Possible values: [SESSION_STATE_UNSPECIFIED, SESSION_STATE_ACTIVE, SESSION_STATE_TERMINATED]
Default value: SESSION_STATE_UNSPECIFIED
current state of the session
userId string
userName string
loginName string
displayName string
the display name of the user
details object
sequence uint64
on read: the sequence of the last event reduced by the projection
on manipulation: the timestamp of the event(s) added by the manipulation
creationDate date-time
on read: the timestamp of the first event of the object
on create: the timestamp of the event(s) added by the manipulation
changeDate date-time
on read: the timestamp of the last event reduced by the projection
on manipulation: the
resourceOwner resource_owner is the organization an object belongs to
avatarUrl string
avatar URL of the user
]

{
  "result": [
    {
      "sessionId": "69629023906488334",
      "agentId": "69629023906488334",
      "authState": "SESSION_STATE_UNSPECIFIED",
      "userId": "69629023906488334",
      "userName": "gigi-giraffe",
      "loginName": "gigi@zitadel.com",
      "displayName": "Gigi Giraffe",
      "details": {
        "sequence": "2",
        "creationDate": "2024-03-27T10:05:48.530Z",
        "changeDate": "2024-03-27T10:05:48.530Z",
        "resourceOwner": "69629023906488334"
      },
      "avatarUrl": "https://api.zitadel.ch/assets/v1/avatar-32432jkh4kj32"
    }
  ]
}

Schema

Example (from schema)

---

Schema

result object[]
Array [
sessionId string
agentId string
authState string
Possible values: [SESSION_STATE_UNSPECIFIED, SESSION_STATE_ACTIVE, SESSION_STATE_TERMINATED]
Default value: SESSION_STATE_UNSPECIFIED
current state of the session
userId string
userName string
loginName string
displayName string
the display name of the user
details object
sequence uint64
on read: the sequence of the last event reduced by the projection
on manipulation: the timestamp of the event(s) added by the manipulation
creationDate date-time
on read: the timestamp of the first event of the object
on create: the timestamp of the event(s) added by the manipulation
changeDate date-time
on read: the timestamp of the last event reduced by the projection
on manipulation: the
resourceOwner resource_owner is the organization an object belongs to
avatarUrl string
avatar URL of the user
]

{
  "result": [
    {
      "sessionId": "69629023906488334",
      "agentId": "69629023906488334",
      "authState": "SESSION_STATE_UNSPECIFIED",
      "userId": "69629023906488334",
      "userName": "gigi-giraffe",
      "loginName": "gigi@zitadel.com",
      "displayName": "Gigi Giraffe",
      "details": {
        "sequence": "2",
        "creationDate": "2024-03-27T10:05:48.530Z",
        "changeDate": "2024-03-27T10:05:48.530Z",
        "resourceOwner": "69629023906488334"
      },
      "avatarUrl": "https://api.zitadel.ch/assets/v1/avatar-32432jkh4kj32"
    }
  ]
}

Schema

Example (from schema)

---

Schema

result object[]
Array [
sessionId string
agentId string
authState string
Possible values: [SESSION_STATE_UNSPECIFIED, SESSION_STATE_ACTIVE, SESSION_STATE_TERMINATED]
Default value: SESSION_STATE_UNSPECIFIED
current state of the session
userId string
userName string
loginName string
displayName string
the display name of the user
details object
sequence uint64
on read: the sequence of the last event reduced by the projection
on manipulation: the timestamp of the event(s) added by the manipulation
creationDate date-time
on read: the timestamp of the first event of the object
on create: the timestamp of the event(s) added by the manipulation
changeDate date-time
on read: the timestamp of the last event reduced by the projection
on manipulation: the
resourceOwner resource_owner is the organization an object belongs to
avatarUrl string
avatar URL of the user
]

{
  "result": [
    {
      "sessionId": "69629023906488334",
      "agentId": "69629023906488334",
      "authState": "SESSION_STATE_UNSPECIFIED",
      "userId": "69629023906488334",
      "userName": "gigi-giraffe",
      "loginName": "gigi@zitadel.com",
      "displayName": "Gigi Giraffe",
      "details": {
        "sequence": "2",
        "creationDate": "2024-03-27T10:05:48.530Z",
        "changeDate": "2024-03-27T10:05:48.531Z",
        "resourceOwner": "69629023906488334"
      },
      "avatarUrl": "https://api.zitadel.ch/assets/v1/avatar-32432jkh4kj32"
    }
  ]
}

An unexpected error response.

application/json

application/grpc

application/grpc-web+proto

Schema

Example (from schema)

---

Schema

code int32
message string
details object[]
Array [
@type string
]

{
  "code": 0,
  "message": "string",
  "details": [
    {
      "@type": "string"
    }
  ]
}

Schema

Example (from schema)

---

Schema

code int32
message string
details object[]
Array [
@type string
]

{
  "code": 0,
  "message": "string",
  "details": [
    {
      "@type": "string"
    }
  ]
}

Schema

Example (from schema)

---

Schema

code int32
message string
details object[]
Array [
@type string
]

{
  "code": 0,
  "message": "string",
  "details": [
    {
      "@type": "string"
    }
  ]
}

Loading...