Revoke multiple OATH tokens

POST {{apiPath}}/environments/{{envID}}/oathJobs

This example uses the oathJobs endpoint to submit a job to revoke multiple tokens.

The body contains an array called tokenIds, consisting of the IDs of the tokens that you want to revoke. The ID to use is the value that was returned in the id field of the response when the OATH token was created.

To check on the status of a submitted job, provide the returned job ID in the URL: {{apiPathTest}}/environments/{{envID}}/oathJobs/{{oathTokenRevokeJobID}}

Request Model

Refer to OATH Tokens for the complete data models.

Property Type Required?

Property	Type	Required?
`async`	String	Required
`forceUnpair`	Boolean	Optional
`tokenIds`	Array	Required
`type`	String	Required

async

String

Required

forceUnpair

Boolean

Optional

tokenIds

Array

Required

type

String

Required

Headers

Authorization Bearer {{accessToken}}

Content-Type application/vnd.pingidentity.job.oathtokens.revoke+json

Body

raw ( application/vnd.pingidentity.job.oathtokens.revoke+json )

{
    "type": "REVOKE_OATH_TOKENS",
    "async": true,
    "forceUnpair": false,
    "tokenIds": [
           "05e84ab4-2a23-43ae-947e-e90fdbe1bbdf",
            "1063f990-a872-43dd-be4d-93ec45b10fcd",
            "135e68f2-aa20-4ad6-89f0-88d76ecf7c2b",
            "4acfec0a-2cbd-409e-ae54-6bffd9011a4e",
            "5b80ea97-2c7f-41d4-9069-504b9bfdec52"
    ]
}

Example Request

curl --location --globoff '{{apiPath}}/environments/{{envID}}/oathJobs' \
--header 'Content-Type: application/vnd.pingidentity.job.oathtokens.revoke+json' \
--header 'Authorization: Bearer {{accessToken}}' \
--data '{
    "type": "REVOKE_OATH_TOKENS",
    "async": true,
    "forceUnpair": false,
    "tokenIds": [
           "05e84ab4-2a23-43ae-947e-e90fdbe1bbdf",
            "1063f990-a872-43dd-be4d-93ec45b10fcd",
            "135e68f2-aa20-4ad6-89f0-88d76ecf7c2b",
            "4acfec0a-2cbd-409e-ae54-6bffd9011a4e",
            "5b80ea97-2c7f-41d4-9069-504b9bfdec52"
    ]
}'

var options = new RestClientOptions("{{apiPath}}/environments/{{envID}}/oathJobs")
{
  MaxTimeout = -1,
};
var client = new RestClient(options);
var request = new RestRequest("", Method.Post);
request.AddHeader("Content-Type", "application/vnd.pingidentity.job.oathtokens.revoke+json");
request.AddHeader("Authorization", "Bearer {{accessToken}}");
var body = @"{" + "\n" +
@"    ""type"": ""REVOKE_OATH_TOKENS""," + "\n" +
@"    ""async"": true," + "\n" +
@"    ""forceUnpair"": false," + "\n" +
@"    ""tokenIds"": [" + "\n" +
@"           ""05e84ab4-2a23-43ae-947e-e90fdbe1bbdf""," + "\n" +
@"            ""1063f990-a872-43dd-be4d-93ec45b10fcd""," + "\n" +
@"            ""135e68f2-aa20-4ad6-89f0-88d76ecf7c2b""," + "\n" +
@"            ""4acfec0a-2cbd-409e-ae54-6bffd9011a4e""," + "\n" +
@"            ""5b80ea97-2c7f-41d4-9069-504b9bfdec52""" + "\n" +
@"    ]" + "\n" +
@"}";
request.AddStringBody(body, DataFormat.Json);
RestResponse response = await client.ExecuteAsync(request);
Console.WriteLine(response.Content);

package main

import (
  "fmt"
  "strings"
  "net/http"
  "io"
)

func main() {

  url := "{{apiPath}}/environments/{{envID}}/oathJobs"
  method := "POST"

  payload := strings.NewReader(`{
    "type": "REVOKE_OATH_TOKENS",
    "async": true,
    "forceUnpair": false,
    "tokenIds": [
           "05e84ab4-2a23-43ae-947e-e90fdbe1bbdf",
            "1063f990-a872-43dd-be4d-93ec45b10fcd",
            "135e68f2-aa20-4ad6-89f0-88d76ecf7c2b",
            "4acfec0a-2cbd-409e-ae54-6bffd9011a4e",
            "5b80ea97-2c7f-41d4-9069-504b9bfdec52"
    ]
}`)

  client := &http.Client {
  }
  req, err := http.NewRequest(method, url, payload)

  if err != nil {
    fmt.Println(err)
    return
  }
  req.Header.Add("Content-Type", "application/vnd.pingidentity.job.oathtokens.revoke+json")
  req.Header.Add("Authorization", "Bearer {{accessToken}}")

  res, err := client.Do(req)
  if err != nil {
    fmt.Println(err)
    return
  }
  defer res.Body.Close()

  body, err := io.ReadAll(res.Body)
  if err != nil {
    fmt.Println(err)
    return
  }
  fmt.Println(string(body))
}

POST /environments/{{envID}}/oathJobs HTTP/1.1
Host: {{apiPath}}
Content-Type: application/vnd.pingidentity.job.oathtokens.revoke+json
Authorization: Bearer {{accessToken}}

{
    "type": "REVOKE_OATH_TOKENS",
    "async": true,
    "forceUnpair": false,
    "tokenIds": [
           "05e84ab4-2a23-43ae-947e-e90fdbe1bbdf",
            "1063f990-a872-43dd-be4d-93ec45b10fcd",
            "135e68f2-aa20-4ad6-89f0-88d76ecf7c2b",
            "4acfec0a-2cbd-409e-ae54-6bffd9011a4e",
            "5b80ea97-2c7f-41d4-9069-504b9bfdec52"
    ]
}

OkHttpClient client = new OkHttpClient().newBuilder()
  .build();
MediaType mediaType = MediaType.parse("application/vnd.pingidentity.job.oathtokens.revoke+json");
RequestBody body = RequestBody.create(mediaType, "{\n    \"type\": \"REVOKE_OATH_TOKENS\",\n    \"async\": true,\n    \"forceUnpair\": false,\n    \"tokenIds\": [\n           \"05e84ab4-2a23-43ae-947e-e90fdbe1bbdf\",\n            \"1063f990-a872-43dd-be4d-93ec45b10fcd\",\n            \"135e68f2-aa20-4ad6-89f0-88d76ecf7c2b\",\n            \"4acfec0a-2cbd-409e-ae54-6bffd9011a4e\",\n            \"5b80ea97-2c7f-41d4-9069-504b9bfdec52\"\n    ]\n}");
Request request = new Request.Builder()
  .url("{{apiPath}}/environments/{{envID}}/oathJobs")
  .method("POST", body)
  .addHeader("Content-Type", "application/vnd.pingidentity.job.oathtokens.revoke+json")
  .addHeader("Authorization", "Bearer {{accessToken}}")
  .build();
Response response = client.newCall(request).execute();

var settings = {
  "url": "{{apiPath}}/environments/{{envID}}/oathJobs",
  "method": "POST",
  "timeout": 0,
  "headers": {
    "Content-Type": "application/vnd.pingidentity.job.oathtokens.revoke+json",
    "Authorization": "Bearer {{accessToken}}"
  },
  "data": JSON.stringify({
    "type": "REVOKE_OATH_TOKENS",
    "async": true,
    "forceUnpair": false,
    "tokenIds": [
      "05e84ab4-2a23-43ae-947e-e90fdbe1bbdf",
      "1063f990-a872-43dd-be4d-93ec45b10fcd",
      "135e68f2-aa20-4ad6-89f0-88d76ecf7c2b",
      "4acfec0a-2cbd-409e-ae54-6bffd9011a4e",
      "5b80ea97-2c7f-41d4-9069-504b9bfdec52"
    ]
  }),
};

$.ajax(settings).done(function (response) {
  console.log(response);
});

var request = require('request');
var options = {
  'method': 'POST',
  'url': '{{apiPath}}/environments/{{envID}}/oathJobs',
  'headers': {
    'Content-Type': 'application/vnd.pingidentity.job.oathtokens.revoke+json',
    'Authorization': 'Bearer {{accessToken}}'
  },
  body: JSON.stringify({
    "type": "REVOKE_OATH_TOKENS",
    "async": true,
    "forceUnpair": false,
    "tokenIds": [
      "05e84ab4-2a23-43ae-947e-e90fdbe1bbdf",
      "1063f990-a872-43dd-be4d-93ec45b10fcd",
      "135e68f2-aa20-4ad6-89f0-88d76ecf7c2b",
      "4acfec0a-2cbd-409e-ae54-6bffd9011a4e",
      "5b80ea97-2c7f-41d4-9069-504b9bfdec52"
    ]
  })

};
request(options, function (error, response) {
  if (error) throw new Error(error);
  console.log(response.body);
});

import requests
import json

url = "{{apiPath}}/environments/{{envID}}/oathJobs"

payload = json.dumps({
  "type": "REVOKE_OATH_TOKENS",
  "async": True,
  "forceUnpair": False,
  "tokenIds": [
    "05e84ab4-2a23-43ae-947e-e90fdbe1bbdf",
    "1063f990-a872-43dd-be4d-93ec45b10fcd",
    "135e68f2-aa20-4ad6-89f0-88d76ecf7c2b",
    "4acfec0a-2cbd-409e-ae54-6bffd9011a4e",
    "5b80ea97-2c7f-41d4-9069-504b9bfdec52"
  ]
})
headers = {
  'Content-Type': 'application/vnd.pingidentity.job.oathtokens.revoke+json',
  'Authorization': 'Bearer {{accessToken}}'
}

response = requests.request("POST", url, headers=headers, data=payload)

print(response.text)

<?php
require_once 'HTTP/Request2.php';
$request = new HTTP_Request2();
$request->setUrl('{{apiPath}}/environments/{{envID}}/oathJobs');
$request->setMethod(HTTP_Request2::METHOD_POST);
$request->setConfig(array(
  'follow_redirects' => TRUE
));
$request->setHeader(array(
  'Content-Type' => 'application/vnd.pingidentity.job.oathtokens.revoke+json',
  'Authorization' => 'Bearer {{accessToken}}'
));
$request->setBody('{\n    "type": "REVOKE_OATH_TOKENS",\n    "async": true,\n    "forceUnpair": false,\n    "tokenIds": [\n           "05e84ab4-2a23-43ae-947e-e90fdbe1bbdf",\n            "1063f990-a872-43dd-be4d-93ec45b10fcd",\n            "135e68f2-aa20-4ad6-89f0-88d76ecf7c2b",\n            "4acfec0a-2cbd-409e-ae54-6bffd9011a4e",\n            "5b80ea97-2c7f-41d4-9069-504b9bfdec52"\n    ]\n}');
try {
  $response = $request->send();
  if ($response->getStatus() == 200) {
    echo $response->getBody();
  }
  else {
    echo 'Unexpected HTTP status: ' . $response->getStatus() . ' ' .
    $response->getReasonPhrase();
  }
}
catch(HTTP_Request2_Exception $e) {
  echo 'Error: ' . $e->getMessage();
}

require "uri"
require "json"
require "net/http"

url = URI("{{apiPath}}/environments/{{envID}}/oathJobs")

http = Net::HTTP.new(url.host, url.port);
request = Net::HTTP::Post.new(url)
request["Content-Type"] = "application/vnd.pingidentity.job.oathtokens.revoke+json"
request["Authorization"] = "Bearer {{accessToken}}"
request.body = JSON.dump({
  "type": "REVOKE_OATH_TOKENS",
  "async": true,
  "forceUnpair": false,
  "tokenIds": [
    "05e84ab4-2a23-43ae-947e-e90fdbe1bbdf",
    "1063f990-a872-43dd-be4d-93ec45b10fcd",
    "135e68f2-aa20-4ad6-89f0-88d76ecf7c2b",
    "4acfec0a-2cbd-409e-ae54-6bffd9011a4e",
    "5b80ea97-2c7f-41d4-9069-504b9bfdec52"
  ]
})

response = http.request(request)
puts response.read_body

let parameters = "{\n    \"type\": \"REVOKE_OATH_TOKENS\",\n    \"async\": true,\n    \"forceUnpair\": false,\n    \"tokenIds\": [\n           \"05e84ab4-2a23-43ae-947e-e90fdbe1bbdf\",\n            \"1063f990-a872-43dd-be4d-93ec45b10fcd\",\n            \"135e68f2-aa20-4ad6-89f0-88d76ecf7c2b\",\n            \"4acfec0a-2cbd-409e-ae54-6bffd9011a4e\",\n            \"5b80ea97-2c7f-41d4-9069-504b9bfdec52\"\n    ]\n}"
let postData = parameters.data(using: .utf8)

var request = URLRequest(url: URL(string: "{{apiPath}}/environments/{{envID}}/oathJobs")!,timeoutInterval: Double.infinity)
request.addValue("application/vnd.pingidentity.job.oathtokens.revoke+json", forHTTPHeaderField: "Content-Type")
request.addValue("Bearer {{accessToken}}", forHTTPHeaderField: "Authorization")

request.httpMethod = "POST"
request.httpBody = postData

let task = URLSession.shared.dataTask(with: request) { data, response, error in
  guard let data = data else {
    print(String(describing: error))
    return
  }
  print(String(data: data, encoding: .utf8)!)
}

task.resume()

Example Response

202 Accepted

{
    "_links": {
        "self": {
            "href": "https://api.test-one-pingone.com/v1/environments/abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6/jobs/f445e588-1963-47de-b5e4-ce3cf0d58f11"
        },
        "environment": {
            "href": "https://api.test-one-pingone.com/v1/environments/abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6"
        }
    },
    "id": "f445e588-1963-47de-b5e4-ce3cf0d58f11",
    "environment": {
        "id": "abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6"
    },
    "type": "REVOKE_OATH_TOKENS",
    "async": true,
    "status": "PENDING",
    "result": {
        "revoked": 0
    }
}

PingOne Platform APIs

Revoke multiple OATH tokens

Headers

Body

Example Request

Example Response