Search sessions
POSThttps://$CUSTOM-DOMAIN/v2/sessions/search
Search for sessions
Request​
- application/json
- application/grpc
- application/grpc-web+proto
Bodyrequired
query object
queries object[]
sortingColumnstring
Possible values: [SESSION_FIELD_NAME_UNSPECIFIED
, SESSION_FIELD_NAME_CREATION_DATE
]
Default value:
SESSION_FIELD_NAME_UNSPECIFIED
Bodyrequired
query object
queries object[]
sortingColumnstring
Possible values: [SESSION_FIELD_NAME_UNSPECIFIED
, SESSION_FIELD_NAME_CREATION_DATE
]
Default value:
SESSION_FIELD_NAME_UNSPECIFIED
Bodyrequired
query object
queries object[]
sortingColumnstring
Possible values: [SESSION_FIELD_NAME_UNSPECIFIED
, SESSION_FIELD_NAME_CREATION_DATE
]
Default value:
SESSION_FIELD_NAME_UNSPECIFIED
Responses​
- 200
- 400
- 403
- 404
- default
OK
- application/json
- application/grpc
- application/grpc-web+proto
- Schema
- Example (auto)
Schema
details object
sessions object[]
{
"details": {
"totalResult": "2",
"processedSequence": "267831",
"timestamp": "2024-07-29T15:51:28.071Z"
},
"sessions": [
{
"id": "string",
"creationDate": "2024-07-29T15:51:28.071Z",
"changeDate": "2024-07-29T15:51:28.071Z",
"sequence": "string",
"factors": {
"user": {
"verifiedAt": "2024-07-29T15:51:28.071Z",
"id": "string",
"loginName": "string",
"displayName": "string",
"organizationId": "string"
},
"password": {
"verifiedAt": "2024-07-29T15:51:28.071Z"
},
"webAuthN": {
"verifiedAt": "2024-07-29T15:51:28.071Z",
"userVerified": true
},
"intent": {
"verifiedAt": "2024-07-29T15:51:28.071Z"
},
"totp": {
"verifiedAt": "2024-07-29T15:51:28.071Z"
},
"otpSms": {
"verifiedAt": "2024-07-29T15:51:28.071Z"
},
"otpEmail": {
"verifiedAt": "2024-07-29T15:51:28.071Z"
}
},
"metadata": {},
"userAgent": {
"fingerprintId": "string",
"ip": "string",
"description": "string",
"header": {}
},
"expirationDate": "2024-07-29T15:51:28.071Z"
}
]
}
- Schema
- Example (auto)
Schema
details object
sessions object[]
{
"details": {
"totalResult": "2",
"processedSequence": "267831",
"timestamp": "2024-07-29T15:51:28.071Z"
},
"sessions": [
{
"id": "string",
"creationDate": "2024-07-29T15:51:28.071Z",
"changeDate": "2024-07-29T15:51:28.071Z",
"sequence": "string",
"factors": {
"user": {
"verifiedAt": "2024-07-29T15:51:28.071Z",
"id": "string",
"loginName": "string",
"displayName": "string",
"organizationId": "string"
},
"password": {
"verifiedAt": "2024-07-29T15:51:28.071Z"
},
"webAuthN": {
"verifiedAt": "2024-07-29T15:51:28.071Z",
"userVerified": true
},
"intent": {
"verifiedAt": "2024-07-29T15:51:28.071Z"
},
"totp": {
"verifiedAt": "2024-07-29T15:51:28.071Z"
},
"otpSms": {
"verifiedAt": "2024-07-29T15:51:28.071Z"
},
"otpEmail": {
"verifiedAt": "2024-07-29T15:51:28.071Z"
}
},
"metadata": {},
"userAgent": {
"fingerprintId": "string",
"ip": "string",
"description": "string",
"header": {}
},
"expirationDate": "2024-07-29T15:51:28.071Z"
}
]
}
- Schema
- Example (auto)
Schema
details object
sessions object[]
{
"details": {
"totalResult": "2",
"processedSequence": "267831",
"timestamp": "2024-07-29T15:51:28.071Z"
},
"sessions": [
{
"id": "string",
"creationDate": "2024-07-29T15:51:28.071Z",
"changeDate": "2024-07-29T15:51:28.071Z",
"sequence": "string",
"factors": {
"user": {
"verifiedAt": "2024-07-29T15:51:28.071Z",
"id": "string",
"loginName": "string",
"displayName": "string",
"organizationId": "string"
},
"password": {
"verifiedAt": "2024-07-29T15:51:28.071Z"
},
"webAuthN": {
"verifiedAt": "2024-07-29T15:51:28.071Z",
"userVerified": true
},
"intent": {
"verifiedAt": "2024-07-29T15:51:28.071Z"
},
"totp": {
"verifiedAt": "2024-07-29T15:51:28.071Z"
},
"otpSms": {
"verifiedAt": "2024-07-29T15:51:28.071Z"
},
"otpEmail": {
"verifiedAt": "2024-07-29T15:51:28.071Z"
}
},
"metadata": {},
"userAgent": {
"fingerprintId": "string",
"ip": "string",
"description": "string",
"header": {}
},
"expirationDate": "2024-07-29T15:51:28.071Z"
}
]
}
invalid list query
- application/json
- application/grpc
- application/grpc-web+proto
- Schema
- Example (auto)
Schema
codeint32
messagestring
details object[]
{
"code": 0,
"message": "string",
"details": [
{
"@type": "string"
}
]
}
- Schema
- Example (auto)
Schema
codeint32
messagestring
details object[]
{
"code": 0,
"message": "string",
"details": [
{
"@type": "string"
}
]
}
- Schema
- Example (auto)
Schema
codeint32
messagestring
details object[]
{
"code": 0,
"message": "string",
"details": [
{
"@type": "string"
}
]
}
Returned when the user does not have permission to access the resource.
- application/json
- application/grpc
- application/grpc-web+proto
- Schema
- Example (auto)
Schema
codeint32
messagestring
details object[]
{
"code": 0,
"message": "string",
"details": [
{
"@type": "string"
}
]
}
- Schema
- Example (auto)
Schema
codeint32
messagestring
details object[]
{
"code": 0,
"message": "string",
"details": [
{
"@type": "string"
}
]
}
- Schema
- Example (auto)
Schema
codeint32
messagestring
details object[]
{
"code": 0,
"message": "string",
"details": [
{
"@type": "string"
}
]
}
Returned when the resource does not exist.
- application/json
- application/grpc
- application/grpc-web+proto
- Schema
- Example (auto)
Schema
codeint32
messagestring
details object[]
{
"code": 0,
"message": "string",
"details": [
{
"@type": "string"
}
]
}
- Schema
- Example (auto)
Schema
codeint32
messagestring
details object[]
{
"code": 0,
"message": "string",
"details": [
{
"@type": "string"
}
]
}
- Schema
- Example (auto)
Schema
codeint32
messagestring
details object[]
{
"code": 0,
"message": "string",
"details": [
{
"@type": "string"
}
]
}
An unexpected error response.
- application/json
- application/grpc
- application/grpc-web+proto
- Schema
- Example (auto)
Schema
codeint32
messagestring
details object[]
{
"code": 0,
"message": "string",
"details": [
{
"@type": "string"
}
]
}
- Schema
- Example (auto)
Schema
codeint32
messagestring
details object[]
{
"code": 0,
"message": "string",
"details": [
{
"@type": "string"
}
]
}
- Schema
- Example (auto)
Schema
codeint32
messagestring
details object[]
{
"code": 0,
"message": "string",
"details": [
{
"@type": "string"
}
]
}
Authorization: oauth2
name: OAuth2type: oauth2scopes:openid,urn:zitadel:iam:org:project:id:zitadel:aud
flows: { "authorizationCode": { "authorizationUrl": "$CUSTOM-DOMAIN/oauth/v2/authorize", "tokenUrl": "$CUSTOM-DOMAIN/oauth/v2/token", "scopes": { "openid": "openid", "urn:zitadel:iam:org:project:id:zitadel:aud": "urn:zitadel:iam:org:project:id:zitadel:aud" } } }
- csharp
- curl
- dart
- go
- http
- java
- javascript
- kotlin
- c
- nodejs
- objective-c
- ocaml
- php
- powershell
- python
- r
- ruby
- rust
- shell
- swift
- HTTPCLIENT
- RESTSHARP
var client = new HttpClient();
var request = new HttpRequestMessage(HttpMethod.Post, "https://$CUSTOM-DOMAIN/v2/sessions/search");
request.Headers.Add("Accept", "application/json");
request.Headers.Add("Authorization", "Bearer <token>");
var content = new StringContent("{\n \"query\": {\n \"offset\": \"0\",\n \"limit\": 100,\n \"asc\": true\n },\n \"queries\": [\n {\n \"idsQuery\": {\n \"ids\": [\n \"string\"\n ]\n },\n \"userIdQuery\": {\n \"id\": \"string\"\n },\n \"creationDateQuery\": {\n \"creationDate\": \"2024-07-29T15:51:28.071Z\",\n \"method\": \"TIMESTAMP_QUERY_METHOD_EQUALS\"\n },\n \"creatorQuery\": {\n \"id\": \"69629023906488334\"\n },\n \"userAgentQuery\": {\n \"fingerprintId\": \"69629023906488334\"\n },\n \"expirationDateQuery\": {\n \"expirationDate\": \"2024-07-29T15:51:28.071Z\",\n \"method\": \"TIMESTAMP_QUERY_METHOD_EQUALS\"\n }\n }\n ],\n \"sortingColumn\": \"SESSION_FIELD_NAME_UNSPECIFIED\"\n}", null, "application/json");
request.Content = content;
var response = await client.SendAsync(request);
response.EnsureSuccessStatusCode();
Console.WriteLine(await response.Content.ReadAsStringAsync());
ResponseClear