Get My User Sessions
POST/users/me/sessions/_search
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.
Request​
- application/json
- application/grpc
- application/grpc-web+proto
Body
required
object
Body
required
object
Body
required
object
Responses​
- 200
- default
A successful response.
- application/json
- application/grpc
- application/grpc-web+proto
- Schema
- Example (from schema)
Schema
Array [
]
result
object[]
Possible values: [SESSION_STATE_UNSPECIFIED
, SESSION_STATE_ACTIVE
, SESSION_STATE_TERMINATED
]
Default value: SESSION_STATE_UNSPECIFIED
current state of the session
the display name of the user
details
object
on read: the sequence of the last event reduced by the projection
on manipulation: the timestamp of the event(s) added by the manipulation
on read: the timestamp of the first event of the object
on create: the timestamp of the event(s) added by the manipulation
on read: the timestamp of the last event reduced by the projection
on manipulation: the
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-11-21T14:48:11.037Z",
"changeDate": "2024-11-21T14:48:11.037Z",
"resourceOwner": "69629023906488334"
},
"avatarUrl": "https://api.zitadel.ch/assets/v1/avatar-32432jkh4kj32"
}
]
}
- Schema
- Example (from schema)
Schema
Array [
]
result
object[]
Possible values: [SESSION_STATE_UNSPECIFIED
, SESSION_STATE_ACTIVE
, SESSION_STATE_TERMINATED
]
Default value: SESSION_STATE_UNSPECIFIED
current state of the session
the display name of the user
details
object
on read: the sequence of the last event reduced by the projection
on manipulation: the timestamp of the event(s) added by the manipulation
on read: the timestamp of the first event of the object
on create: the timestamp of the event(s) added by the manipulation
on read: the timestamp of the last event reduced by the projection
on manipulation: the
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-11-21T14:48:11.038Z",
"changeDate": "2024-11-21T14:48:11.038Z",
"resourceOwner": "69629023906488334"
},
"avatarUrl": "https://api.zitadel.ch/assets/v1/avatar-32432jkh4kj32"
}
]
}
- Schema
- Example (from schema)
Schema
Array [
]
result
object[]
Possible values: [SESSION_STATE_UNSPECIFIED
, SESSION_STATE_ACTIVE
, SESSION_STATE_TERMINATED
]
Default value: SESSION_STATE_UNSPECIFIED
current state of the session
the display name of the user
details
object
on read: the sequence of the last event reduced by the projection
on manipulation: the timestamp of the event(s) added by the manipulation
on read: the timestamp of the first event of the object
on create: the timestamp of the event(s) added by the manipulation
on read: the timestamp of the last event reduced by the projection
on manipulation: the
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-11-21T14:48:11.038Z",
"changeDate": "2024-11-21T14:48:11.039Z",
"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
Array [
]
details
object[]
{
"code": 0,
"message": "string",
"details": [
{
"@type": "string"
}
]
}
- Schema
- Example (from schema)
Schema
Array [
]
details
object[]
{
"code": 0,
"message": "string",
"details": [
{
"@type": "string"
}
]
}
- Schema
- Example (from schema)
Schema
Array [
]
details
object[]
{
"code": 0,
"message": "string",
"details": [
{
"@type": "string"
}
]
}