Invalidate user sessions

Base URL: https://{kibana_url}

POST /api/security/session/_invalidate

Auth

Invalidate user sessions that match a query. To use this API, you must be a superuser.

Header parameters

kbn-xsrf string required: A required header to protect against CSRF attacks

Request body

match enum required: The method Kibana uses to determine which sessions to invalidate. If it is all, all existing sessions will be invalidated. If it is query, only the sessions that match the query will be invalidated.; Values: all query
query object: The query that Kibana uses to match the sessions to invalidate when the match parameter is set to query.

Responses

Indicates a successful call

application/json

total integer: The number of sessions that were successfully invalidated.

403

Indicates that the user may not be authorized to invalidate sessions for other users.

Base URL: https://{kibana_url}

Examples

Request Console 1 / 2 languages

Run POST api/security/session/_invalidate to invalidate all existing sessions.

Console Kibana Dev Tools

POST kbn:/api/security/session/_invalidate
{
  "match" : "all"
}

Generated from the API spec

curl Shell

curl -X POST "${KIBANA_URL}/api/security/session/_invalidate" \
  -H "kbn-xsrf: true" \
  -H "Authorization: ApiKey ${API_KEY}" \
  -H "Content-Type: application/json" \
  -d '{
    "match" : "all"
  }'

Generated from the API spec

Response

{
  "total": 0
}

Generated from the API spec

Request Console 1 / 2 languages

Run POST api/security/session/_invalidate to invalidate sessions that were created by any SAML authentication provider.

Console Kibana Dev Tools

POST kbn:api/security/session/_invalidate
{
  "match" : "query",
  "query": {
    "provider" : { "type": "saml" }
  }
}

Generated from the API spec

curl Shell

curl -X POST "${KIBANA_URL}/api/security/session/_invalidate" \
  -H "kbn-xsrf: true" \
  -H "Authorization: ApiKey ${API_KEY}" \
  -H "Content-Type: application/json" \
  -d '{
    "match" : "query",
    "query": {
      "provider" : { "type": "saml" }
    }
  }'

Generated from the API spec

Response

{
  "total": 0
}

Generated from the API spec

Request Console 1 / 2 languages

Run POST api/security/session/_invalidate to invalidate sessions that were created by the SAML authentication provider named saml1.

Console Kibana Dev Tools

POST kbn:api/security/session/_invalidate
{
  "match" : "query",
  "query": {
    "provider" : { "type": "saml", "name": "saml1" }
  }
}

Generated from the API spec

curl Shell

curl -X POST "${KIBANA_URL}/api/security/session/_invalidate" \
  -H "kbn-xsrf: true" \
  -H "Authorization: ApiKey ${API_KEY}" \
  -H "Content-Type: application/json" \
  -d '{
    "match" : "query",
    "query": {
      "provider" : { "type": "saml", "name": "saml1" }
    }
  }'

Generated from the API spec

Response

{
  "total": 0
}

Generated from the API spec

Request Console 1 / 2 languages

Run POST api/security/session/_invalidate to invalidate sessions that were created by any OpenID Connect authentication provider for the user with the username user@my-oidc-sso.com.

Console Kibana Dev Tools

POST kbn:api/security/session/_invalidate
{
  "match" : "query",
  "query": {
    "provider" : { "type": "oidc" },
    "username": "user@my-oidc-sso.com"
  }
}

Generated from the API spec

curl Shell

curl -X POST "${KIBANA_URL}/api/security/session/_invalidate" \
  -H "kbn-xsrf: true" \
  -H "Authorization: ApiKey ${API_KEY}" \
  -H "Content-Type: application/json" \
  -d '{
    "match" : "query",
    "query": {
      "provider" : { "type": "oidc" },
      "username": "user@my-oidc-sso.com"
    }
  }'

Generated from the API spec

Response

{
  "total": 0
}

Generated from the API spec

Header parameters

Request body { }

Responses

Request body