PingOne Platform APIs

Revoke User OAuth Scope Consent

 

PATCH {{apiPath}}/environments/{{envID}}/users/{{userID}}/oauthConsents/{{oauthConsentID}}

The PATCH {{apiPath}}/environments/{{envID}}/users/{{userID}}/oauthConsents/{{oauthConsentID}} operation gives the actor the ability to revoke an OAuth scope consent for the specified user. This operation uses the application/vnd.pingidentity.consent.revoke+json custom content type in the request header.

Prerequisites

Request Model

For property descriptions, refer to OAuth scope consent data model.

Property Type Required?

status

String

Required

Headers

Authorization      Bearer {{accessToken}}

Content-Type      application/vnd.pingidentity.consent.revoke+json

Body

raw ( application/vnd.pingidentity.consent.revoke+json )

{
  "status" : "REVOKED"
}

Example Request

  • cURL

  • C#

  • Go

  • HTTP

  • Java

  • jQuery

  • NodeJS

  • Python

  • PHP

  • Ruby

  • Swift

curl --location --globoff --request PATCH '{{apiPath}}/environments/{{envID}}/users/{{userID}}/oauthConsents/{{oauthConsentID}}' \
--header 'Content-Type: application/vnd.pingidentity.consent.revoke+json' \
--header 'Authorization: Bearer {{accessToken}}' \
--data '{
  "status" : "REVOKED"
}'
var options = new RestClientOptions("{{apiPath}}/environments/{{envID}}/users/{{userID}}/oauthConsents/{{oauthConsentID}}")
{
  MaxTimeout = -1,
};
var client = new RestClient(options);
var request = new RestRequest("", Method.Patch);
request.AddHeader("Content-Type", "application/vnd.pingidentity.consent.revoke+json");
request.AddHeader("Authorization", "Bearer {{accessToken}}");
var body = @"{" + "\n" +
@"  ""status"" : ""REVOKED""" + "\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}}/users/{{userID}}/oauthConsents/{{oauthConsentID}}"
  method := "PATCH"

  payload := strings.NewReader(`{
  "status" : "REVOKED"
}`)

  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.consent.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))
}
PATCH /environments/{{envID}}/users/{{userID}}/oauthConsents/{{oauthConsentID}} HTTP/1.1
Host: {{apiPath}}
Content-Type: application/vnd.pingidentity.consent.revoke+json
Authorization: Bearer {{accessToken}}

{
  "status" : "REVOKED"
}
OkHttpClient client = new OkHttpClient().newBuilder()
  .build();
MediaType mediaType = MediaType.parse("application/vnd.pingidentity.consent.revoke+json");
RequestBody body = RequestBody.create(mediaType, "{\n  \"status\" : \"REVOKED\"\n}\n");
Request request = new Request.Builder()
  .url("{{apiPath}}/environments/{{envID}}/users/{{userID}}/oauthConsents/{{oauthConsentID}}")
  .method("PATCH", body)
  .addHeader("Content-Type", "application/vnd.pingidentity.consent.revoke+json")
  .addHeader("Authorization", "Bearer {{accessToken}}")
  .build();
Response response = client.newCall(request).execute();
var settings = {
  "url": "{{apiPath}}/environments/{{envID}}/users/{{userID}}/oauthConsents/{{oauthConsentID}}",
  "method": "PATCH",
  "timeout": 0,
  "headers": {
    "Content-Type": "application/vnd.pingidentity.consent.revoke+json",
    "Authorization": "Bearer {{accessToken}}"
  },
  "data": JSON.stringify({
    "status": "REVOKED"
  }),
};

$.ajax(settings).done(function (response) {
  console.log(response);
});
var request = require('request');
var options = {
  'method': 'PATCH',
  'url': '{{apiPath}}/environments/{{envID}}/users/{{userID}}/oauthConsents/{{oauthConsentID}}',
  'headers': {
    'Content-Type': 'application/vnd.pingidentity.consent.revoke+json',
    'Authorization': 'Bearer {{accessToken}}'
  },
  body: JSON.stringify({
    "status": "REVOKED"
  })

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

url = "{{apiPath}}/environments/{{envID}}/users/{{userID}}/oauthConsents/{{oauthConsentID}}"

payload = json.dumps({
  "status": "REVOKED"
})
headers = {
  'Content-Type': 'application/vnd.pingidentity.consent.revoke+json',
  'Authorization': 'Bearer {{accessToken}}'
}

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

print(response.text)
<?php
require_once 'HTTP/Request2.php';
$request = new HTTP_Request2();
$request->setUrl('{{apiPath}}/environments/{{envID}}/users/{{userID}}/oauthConsents/{{oauthConsentID}}');
$request->setMethod('PATCH');
$request->setConfig(array(
  'follow_redirects' => TRUE
));
$request->setHeader(array(
  'Content-Type' => 'application/vnd.pingidentity.consent.revoke+json',
  'Authorization' => 'Bearer {{accessToken}}'
));
$request->setBody('{\n  "status" : "REVOKED"\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}}/users/{{userID}}/oauthConsents/{{oauthConsentID}}")

http = Net::HTTP.new(url.host, url.port);
request = Net::HTTP::Patch.new(url)
request["Content-Type"] = "application/vnd.pingidentity.consent.revoke+json"
request["Authorization"] = "Bearer {{accessToken}}"
request.body = JSON.dump({
  "status": "REVOKED"
})

response = http.request(request)
puts response.read_body
let parameters = "{\n  \"status\" : \"REVOKED\"\n}"
let postData = parameters.data(using: .utf8)

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

request.httpMethod = "PATCH"
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

200 OK

{
    "_links": {
        "self": {
            "href": "https://api.pingone.com/v1/environments/abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6/users/01dee5b5-48fa-4a6b-a574-f2ff28ab5b32/oauthConsents/663a3fae-b0fa-4da3-a9ae-f2d60aebe56c"
        },
        "environment": {
            "href": "https://api.pingone.com/v1/environments/abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6"
        },
        "user": {
            "href": "https://api.pingone.com/v1/environments/abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6/users/01dee5b5-48fa-4a6b-a574-f2ff28ab5b32"
        }
    },
    "id": "663a3fae-b0fa-4da3-a9ae-f2d60aebe56c",
    "application": {
        "id": "a4f6b7ed-95be-4dde-b5b5-dde152625b75"
    },
    "applicationName": "externalApp1",
    "applicationType": "EXTERNAL",
    "environment": {
        "id": "abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6"
    },
    "user": {
        "id": "01dee5b5-48fa-4a6b-a574-f2ff28ab5b32"
    },
    "scope": [
        "openid"
    ],
    "status": "REVOKED",
    "consentedAt": "2022-08-24T22:31:45.573Z",
    "updatedAt": "2022-08-24T22:33:13.805Z"
}