PingOne Platform APIs

Update Subscription

 

PUT {{apiPath}}/environments/{{envID}}/subscriptions/{{subscriptionID}}

You can use PUT {{apiPath}}/environments/{{envID}}/subscriptions/{{subscriptionID}} to update the attribute values for a subscription resource in the specified environment.

Prerequisites

Request Model
Property Type Required?

name

String[]

Required

filterOptions.includedActionTypes

String[]

Required

filterOptions.includedApplications

String[]

Optional

filterOptions.includedPopulations

String[]

Optional

httpEndpoint.url

String

Required

httpEndpoint.headers

String[]

Required

format

String

Required

verifyTlsCertificates

Boolean[]

Required

enabled

Boolean

Required

Refer to Subscriptions (webhooks) data model for full property descriptions.

Headers

Authorization      Bearer {{accessToken}}

Content-Type      application/json

Body

raw ( application/json )

{
  "name":"UpdatedSubscription",
  "filterOptions":{
    "includedActionTypes":[
      "USER.CREATED",
      "USER.MODIFIED"
    ],
    "includedPopulations":[
      {"id": "{popID}"}
    ],
    "includedApplications":[
      {"id": "{appID}"}
    ]
  },
   "httpEndpoint":{
    "url":"https://subscriptionendpoint.com",
    "headers":{
      "some-header":"some-value"
    }
  },
  "format":"ACTIVITY",
  "enabled": true,
  "verifyTlsCertificates":true,
  "tlsClientAuthKeyPair":{
      "id": "{{keyID}}"
  }
}

Example Request

  • cURL

  • C#

  • Go

  • HTTP

  • Java

  • jQuery

  • NodeJS

  • Python

  • PHP

  • Ruby

  • Swift

curl --location --globoff --request PUT '{{apiPath}}/environments/{{envID}}/subscriptions/{{subscriptionID}}' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer {{accessToken}}' \
--data '{
  "name":"UpdatedSubscription",
  "filterOptions":{
    "includedActionTypes":[
      "USER.CREATED",
      "USER.MODIFIED"
    ],
    "includedPopulations":[
      {"id": "{popID}"}
    ],
    "includedApplications":[
      {"id": "{appID}"}
    ]
  },
   "httpEndpoint":{
    "url":"https://subscriptionendpoint.com",
    "headers":{
      "some-header":"some-value"
    }
  },
  "format":"ACTIVITY",
  "enabled": true,
  "verifyTlsCertificates":true,
  "tlsClientAuthKeyPair":{
      "id": "{{keyID}}"
  }
}'
var options = new RestClientOptions("{{apiPath}}/environments/{{envID}}/subscriptions/{{subscriptionID}}")
{
  MaxTimeout = -1,
};
var client = new RestClient(options);
var request = new RestRequest("", Method.Put);
request.AddHeader("Content-Type", "application/json");
request.AddHeader("Authorization", "Bearer {{accessToken}}");
var body = @"{" + "\n" +
@"  ""name"":""UpdatedSubscription""," + "\n" +
@"  ""filterOptions"":{" + "\n" +
@"    ""includedActionTypes"":[" + "\n" +
@"      ""USER.CREATED""," + "\n" +
@"      ""USER.MODIFIED""" + "\n" +
@"    ]," + "\n" +
@"    ""includedPopulations"":[" + "\n" +
@"      {""id"": ""{popID}""}" + "\n" +
@"    ]," + "\n" +
@"    ""includedApplications"":[" + "\n" +
@"      {""id"": ""{appID}""}" + "\n" +
@"    ]" + "\n" +
@"  }," + "\n" +
@"   ""httpEndpoint"":{" + "\n" +
@"    ""url"":""https://subscriptionendpoint.com""," + "\n" +
@"    ""headers"":{" + "\n" +
@"      ""some-header"":""some-value""" + "\n" +
@"    }" + "\n" +
@"  }," + "\n" +
@"  ""format"":""ACTIVITY""," + "\n" +
@"  ""enabled"": true," + "\n" +
@"  ""verifyTlsCertificates"":true," + "\n" +
@"  ""tlsClientAuthKeyPair"":{" + "\n" +
@"      ""id"": ""{{keyID}}""" + "\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}}/subscriptions/{{subscriptionID}}"
  method := "PUT"

  payload := strings.NewReader(`{
  "name":"UpdatedSubscription",
  "filterOptions":{
    "includedActionTypes":[
      "USER.CREATED",
      "USER.MODIFIED"
    ],
    "includedPopulations":[
      {"id": "{popID}"}
    ],
    "includedApplications":[
      {"id": "{appID}"}
    ]
  },
   "httpEndpoint":{
    "url":"https://subscriptionendpoint.com",
    "headers":{
      "some-header":"some-value"
    }
  },
  "format":"ACTIVITY",
  "enabled": true,
  "verifyTlsCertificates":true,
  "tlsClientAuthKeyPair":{
      "id": "{{keyID}}"
  }
}`)

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

  if err != nil {
    fmt.Println(err)
    return
  }
  req.Header.Add("Content-Type", "application/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))
}
PUT /environments/{{envID}}/subscriptions/{{subscriptionID}} HTTP/1.1
Host: {{apiPath}}
Content-Type: application/json
Authorization: Bearer {{accessToken}}

{
  "name":"UpdatedSubscription",
  "filterOptions":{
    "includedActionTypes":[
      "USER.CREATED",
      "USER.MODIFIED"
    ],
    "includedPopulations":[
      {"id": "{popID}"}
    ],
    "includedApplications":[
      {"id": "{appID}"}
    ]
  },
   "httpEndpoint":{
    "url":"https://subscriptionendpoint.com",
    "headers":{
      "some-header":"some-value"
    }
  },
  "format":"ACTIVITY",
  "enabled": true,
  "verifyTlsCertificates":true,
  "tlsClientAuthKeyPair":{
      "id": "{{keyID}}"
  }
}
OkHttpClient client = new OkHttpClient().newBuilder()
  .build();
MediaType mediaType = MediaType.parse("application/json");
RequestBody body = RequestBody.create(mediaType, "{\n  \"name\":\"UpdatedSubscription\",\n  \"filterOptions\":{\n    \"includedActionTypes\":[\n      \"USER.CREATED\",\n      \"USER.MODIFIED\"\n    ],\n    \"includedPopulations\":[\n      {\"id\": \"{popID}\"}\n    ],\n    \"includedApplications\":[\n      {\"id\": \"{appID}\"}\n    ]\n  },\n   \"httpEndpoint\":{\n    \"url\":\"https://subscriptionendpoint.com\",\n    \"headers\":{\n      \"some-header\":\"some-value\"\n    }\n  },\n  \"format\":\"ACTIVITY\",\n  \"enabled\": true,\n  \"verifyTlsCertificates\":true,\n  \"tlsClientAuthKeyPair\":{\n      \"id\": \"{{keyID}}\"\n  }  \n}");
Request request = new Request.Builder()
  .url("{{apiPath}}/environments/{{envID}}/subscriptions/{{subscriptionID}}")
  .method("PUT", body)
  .addHeader("Content-Type", "application/json")
  .addHeader("Authorization", "Bearer {{accessToken}}")
  .build();
Response response = client.newCall(request).execute();
var settings = {
  "url": "{{apiPath}}/environments/{{envID}}/subscriptions/{{subscriptionID}}",
  "method": "PUT",
  "timeout": 0,
  "headers": {
    "Content-Type": "application/json",
    "Authorization": "Bearer {{accessToken}}"
  },
  "data": JSON.stringify({
    "name": "UpdatedSubscription",
    "filterOptions": {
      "includedActionTypes": [
        "USER.CREATED",
        "USER.MODIFIED"
      ],
      "includedPopulations": [
        {
          "id": "{popID}"
        }
      ],
      "includedApplications": [
        {
          "id": "{appID}"
        }
      ]
    },
    "httpEndpoint": {
      "url": "https://subscriptionendpoint.com",
      "headers": {
        "some-header": "some-value"
      }
    },
    "format": "ACTIVITY",
    "enabled": true,
    "verifyTlsCertificates": true,
    "tlsClientAuthKeyPair": {
      "id": "{{keyID}}"
    }
  }),
};

$.ajax(settings).done(function (response) {
  console.log(response);
});
var request = require('request');
var options = {
  'method': 'PUT',
  'url': '{{apiPath}}/environments/{{envID}}/subscriptions/{{subscriptionID}}',
  'headers': {
    'Content-Type': 'application/json',
    'Authorization': 'Bearer {{accessToken}}'
  },
  body: JSON.stringify({
    "name": "UpdatedSubscription",
    "filterOptions": {
      "includedActionTypes": [
        "USER.CREATED",
        "USER.MODIFIED"
      ],
      "includedPopulations": [
        {
          "id": "{popID}"
        }
      ],
      "includedApplications": [
        {
          "id": "{appID}"
        }
      ]
    },
    "httpEndpoint": {
      "url": "https://subscriptionendpoint.com",
      "headers": {
        "some-header": "some-value"
      }
    },
    "format": "ACTIVITY",
    "enabled": true,
    "verifyTlsCertificates": true,
    "tlsClientAuthKeyPair": {
      "id": "{{keyID}}"
    }
  })

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

url = "{{apiPath}}/environments/{{envID}}/subscriptions/{{subscriptionID}}"

payload = json.dumps({
  "name": "UpdatedSubscription",
  "filterOptions": {
    "includedActionTypes": [
      "USER.CREATED",
      "USER.MODIFIED"
    ],
    "includedPopulations": [
      {
        "id": "{popID}"
      }
    ],
    "includedApplications": [
      {
        "id": "{appID}"
      }
    ]
  },
  "httpEndpoint": {
    "url": "https://subscriptionendpoint.com",
    "headers": {
      "some-header": "some-value"
    }
  },
  "format": "ACTIVITY",
  "enabled": True,
  "verifyTlsCertificates": True,
  "tlsClientAuthKeyPair": {
    "id": "{{keyID}}"
  }
})
headers = {
  'Content-Type': 'application/json',
  'Authorization': 'Bearer {{accessToken}}'
}

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

print(response.text)
<?php
require_once 'HTTP/Request2.php';
$request = new HTTP_Request2();
$request->setUrl('{{apiPath}}/environments/{{envID}}/subscriptions/{{subscriptionID}}');
$request->setMethod(HTTP_Request2::METHOD_PUT);
$request->setConfig(array(
  'follow_redirects' => TRUE
));
$request->setHeader(array(
  'Content-Type' => 'application/json',
  'Authorization' => 'Bearer {{accessToken}}'
));
$request->setBody('{\n  "name":"UpdatedSubscription",\n  "filterOptions":{\n    "includedActionTypes":[\n      "USER.CREATED",\n      "USER.MODIFIED"\n    ],\n    "includedPopulations":[\n      {"id": "{popID}"}\n    ],\n    "includedApplications":[\n      {"id": "{appID}"}\n    ]\n  },\n   "httpEndpoint":{\n    "url":"https://subscriptionendpoint.com",\n    "headers":{\n      "some-header":"some-value"\n    }\n  },\n  "format":"ACTIVITY",\n  "enabled": true,\n  "verifyTlsCertificates":true,\n  "tlsClientAuthKeyPair":{\n      "id": "{{keyID}}"\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}}/subscriptions/{{subscriptionID}}")

http = Net::HTTP.new(url.host, url.port);
request = Net::HTTP::Put.new(url)
request["Content-Type"] = "application/json"
request["Authorization"] = "Bearer {{accessToken}}"
request.body = JSON.dump({
  "name": "UpdatedSubscription",
  "filterOptions": {
    "includedActionTypes": [
      "USER.CREATED",
      "USER.MODIFIED"
    ],
    "includedPopulations": [
      {
        "id": "{popID}"
      }
    ],
    "includedApplications": [
      {
        "id": "{appID}"
      }
    ]
  },
  "httpEndpoint": {
    "url": "https://subscriptionendpoint.com",
    "headers": {
      "some-header": "some-value"
    }
  },
  "format": "ACTIVITY",
  "enabled": true,
  "verifyTlsCertificates": true,
  "tlsClientAuthKeyPair": {
    "id": "{{keyID}}"
  }
})

response = http.request(request)
puts response.read_body
let parameters = "{\n  \"name\":\"UpdatedSubscription\",\n  \"filterOptions\":{\n    \"includedActionTypes\":[\n      \"USER.CREATED\",\n      \"USER.MODIFIED\"\n    ],\n    \"includedPopulations\":[\n      {\"id\": \"{popID}\"}\n    ],\n    \"includedApplications\":[\n      {\"id\": \"{appID}\"}\n    ]\n  },\n   \"httpEndpoint\":{\n    \"url\":\"https://subscriptionendpoint.com\",\n    \"headers\":{\n      \"some-header\":\"some-value\"\n    }\n  },\n  \"format\":\"ACTIVITY\",\n  \"enabled\": true,\n  \"verifyTlsCertificates\":true,\n  \"tlsClientAuthKeyPair\":{\n      \"id\": \"{{keyID}}\"\n  }  \n}"
let postData = parameters.data(using: .utf8)

var request = URLRequest(url: URL(string: "{{apiPath}}/environments/{{envID}}/subscriptions/{{subscriptionID}}")!,timeoutInterval: Double.infinity)
request.addValue("application/json", forHTTPHeaderField: "Content-Type")
request.addValue("Bearer {{accessToken}}", forHTTPHeaderField: "Authorization")

request.httpMethod = "PUT"
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()