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.

Related to this mutation field are the logoutOfSession() to log out of a user's session, and the updateSessionSettings() to update session settings. There is also the query, sessions() to get a list of all sessions.

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

API Stability Long-Term
Security Requirement & Control ChangeSessions API permission

Syntax

graphql
revokeSession(
     input: RevokeSessionInput!
   ): boolean

For the input, you'll have to give the unique identifier of the session, and the type of session (e.g., a user session). You can use the sessions() to get a list of sessions with their identifiers. See the Given Datatype section for details on the input parameters.

For the results, you'll receive confirmation if successful.

Example

Raw
graphql
mutation {
  revokeSession( input: {
     id: "abc123",
     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: \"abc123\",
     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: \"abc123\",
     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: \"abc123\", ^
     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: \"abc123\",
     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: \"abc123\",
     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: \"abc123\",
     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: \"abc123\",
     revocationType: Session
  } )
}"
}
);


const options = {
  hostname: '$YOUR_LOGSCALE_URL',
  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
  }
}

Given Datatype

For the input datatype, you'll have to give the unique identifier of the session, and the type of session (e.g., a user session). You can use the sessions() to get a list of sessions with their identifiers.

Table: RevokeSessionInput

ParameterTypeRequiredDefaultStabilityDescription
Some arguments may be required, as indicated in the Required column. For return datatypes, this indicates that you must specify which fields you want returned in the results.
Table last updated: Sep 19, 2024
idstringyes Long-TermThe unique identifier of the session.
revocationTypeSessionRevocation__Typeyes Long-TermThe type of revocation. See SessionRevocation__Type.