API Stability Long-Term

The revokeSession() GraphQL mutation is used to revoke a specified session. It can revoke a single session, all sessions for a user, or all sessions in an organization.

For information on session management, see the Session management documentation page. You may also want to look at session().

Syntax

Below is the syntax for the revokeSession() mutation field:

graphql
revokeSession(
     input: RevokeSessionInput!
   ): boolean

Below is an example of how this mutation field might be used:

Raw
graphql
mutation {
  revokeSession( input: {
     id: "ZI14EqR5x8AHSJeBQLm6FfZmjLXOOKOU",
     revocationType: Session
  } )
}
Mac OS or Linux (curl)
shell
curl -v -X POST $YOUR_LOGSCALE_URL/graphql \
    -H "Authorization: Bearer $TOKEN" \
    -H "Content-Type: application/json" \
    -d @- << EOF
{"query" : "mutation {
  revokeSession( input: {
     id: \"ZI14EqR5x8AHSJeBQLm6FfZmjLXOOKOU\",
     revocationType: Session
  } )
}"
}
EOF
Mac OS or Linux (curl) One-line
shell
curl -v -X POST $YOUR_LOGSCALE_URL/graphql \
    -H "Authorization: Bearer $TOKEN" \
    -H "Content-Type: application/json" \
    -d @- << EOF
{"query" : "mutation {
  revokeSession( input: {
     id: \"ZI14EqR5x8AHSJeBQLm6FfZmjLXOOKOU\",
     revocationType: Session
  } )
}"
}
EOF
Windows Cmd and curl
shell
curl -v -X POST $YOUR_LOGSCALE_URL/graphql ^
    -H "Authorization: Bearer $TOKEN" ^
    -H "Content-Type: application/json" ^
    -d @'{"query" : "mutation { ^
  revokeSession( input: { ^
     id: \"ZI14EqR5x8AHSJeBQLm6FfZmjLXOOKOU\", ^
     revocationType: Session ^
  } ) ^
}" ^
} '
Windows Powershell and curl
powershell
curl.exe -X POST 
    -H "Authorization: Bearer $TOKEN"
    -H "Content-Type: application/json"
    -d '{"query" : "mutation {
  revokeSession( input: {
     id: \"ZI14EqR5x8AHSJeBQLm6FfZmjLXOOKOU\",
     revocationType: Session
  } )
}"
}'
    "$YOUR_LOGSCALE_URL/graphql"
Perl
perl
#!/usr/bin/perl

use HTTP::Request;
use LWP;

my $TOKEN = "TOKEN";

my $uri = '$YOUR_LOGSCALE_URL/graphql';

my $query = "mutation {
  revokeSession( input: {
     id: \"ZI14EqR5x8AHSJeBQLm6FfZmjLXOOKOU\",
     revocationType: Session
  } )
}";
$query =~ s/\n/ /g;
my $json = sprintf('{"query" : "%s"}',$query);
my $req = HTTP::Request->new("POST", $uri );

$req->header("Authorization" => "Bearer $TOKEN");
$req->header("Content-Type" => "application/json");

$req->content( $json );

my $lwp = LWP::UserAgent->new;

my $result = $lwp->request( $req );

print $result->{"_content"},"\n";
Python
python
#! /usr/local/bin/python3

import requests

url = '$YOUR_LOGSCALE_URL/graphql'
mydata = r'''{"query" : "mutation {
  revokeSession( input: {
     id: \"ZI14EqR5x8AHSJeBQLm6FfZmjLXOOKOU\",
     revocationType: Session
  } )
}"
}'''

resp = requests.post(url,
                     data = mydata,
                     headers = {
   "Authorization" : "Bearer $TOKEN",
   "Content-Type" : "application/json"
}
)

print(resp.text)
Node.js
javascript
const https = require('https');

const data = JSON.stringify(
    {"query" : "mutation {
  revokeSession( input: {
     id: \"ZI14EqR5x8AHSJeBQLm6FfZmjLXOOKOU\",
     revocationType: Session
  } )
}"
}
);


const options = {
  hostname: '$YOUR_LOGSCALE_URL/graphql',
  path: '/graphql',
  port: 443,
  method: 'POST',
  headers: {
    'Content-Type': 'application/json',
    'Content-Length': data.length,
    Authorization: 'BEARER ' + process.env.TOKEN,
    'User-Agent': 'Node',
  },
};

const req = https.request(options, (res) => {
  let data = '';
  console.log(`statusCode: ${res.statusCode}`);

  res.on('data', (d) => {
    data += d;
  });
  res.on('end', () => {
    console.log(JSON.parse(data).data);
  });
});

req.on('error', (error) => {
  console.error(error);
});

req.write(data);
req.end();
Example Responses
Success (HTTP Response Code 200 OK)
json
{
  "data": {
    "revokeSession": true
  }
}

The id for the input is the unique identifier for the session.

Given Datatypes

For RevokeSessionInput, there are a couple of parameters. Below is a list of them along with a description of each:

Table: RevokeSessionInput

ParameterTypeRequiredDefaultStabilityDescription
Some arguments may be required, as indicated in the Required column. For some fields, this column indicates that a result will always be returned for this column.
Table last updated: Sep 19, 2024
idstringyes Long-TermThe unique identifier of the session.
revocationTypeSessionRevocation__Typeyes Long-TermThe type of revocation. See SessionRevocation__Type.