PingOne Platform APIs

Update Resource

   

PUT {{apiPath}}/environments/{{envID}}/resources/{{resourceID}}

The PUT {{apiPath}}/environments/{{envID}}/resources/{{resourceID}} operation updates the property values of the identified resource entity.

The request body specifies updated property values for the resource name and audience. Any property values not specified in the request body are cleared. The response returns a 200 OK message, and it shows the updated property data for the modified resource entity.

In this example, the description property value was cleared. The accessTokenValiditySeconds property value was cleared and reset to the default value of 3600. The name and audience properties were modified to the values specified in the request body.

Prerequisites

  • Refer to Resources for important overview information.

Request Model
Property Type Required?

accessTokenValiditySeconds

Integer

Required

applicationPermissionsSettings.claimEnabled

Boolean

Optional

audience

String

Required

description

String

Optional

name

String

Required

Refer to the Resources data model for full property descriptions.

Headers

Authorization      Bearer {{accessToken}}

Content-Type      application/json

Body

raw ( application/json )

{
    "name": "CustomResource1709685712",
    "audience": "https://api.custom.eu",
    "applicationPermissionsSettings": {
        "claimEnabled": true
    }
}

Example Request

  • cURL

  • C#

  • Go

  • HTTP

  • Java

  • jQuery

  • NodeJS

  • Python

  • PHP

  • Ruby

  • Swift

curl --location --globoff --request PUT '{{apiPath}}/environments/{{envID}}/resources/{{resourceID}}' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer {{accessToken}}' \
--data '{
    "name": "CustomResource1709685712",
    "audience": "https://api.custom.eu",
    "applicationPermissionsSettings": {
        "claimEnabled": true
    }
}'
var options = new RestClientOptions("{{apiPath}}/environments/{{envID}}/resources/{{resourceID}}")
{
  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"": ""CustomResource1709685712""," + "\n" +
@"    ""audience"": ""https://api.custom.eu""," + "\n" +
@"    ""applicationPermissionsSettings"": {" + "\n" +
@"        ""claimEnabled"": true" + "\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}}/resources/{{resourceID}}"
  method := "PUT"

  payload := strings.NewReader(`{
    "name": "CustomResource1709685712",
    "audience": "https://api.custom.eu",
    "applicationPermissionsSettings": {
        "claimEnabled": true
    }
}`)

  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}}/resources/{{resourceID}} HTTP/1.1
Host: {{apiPath}}
Content-Type: application/json
Authorization: Bearer {{accessToken}}

{
    "name": "CustomResource1709685712",
    "audience": "https://api.custom.eu",
    "applicationPermissionsSettings": {
        "claimEnabled": true
    }
}
OkHttpClient client = new OkHttpClient().newBuilder()
  .build();
MediaType mediaType = MediaType.parse("application/json");
RequestBody body = RequestBody.create(mediaType, "{\n    \"name\": \"CustomResource1709685712\",\n    \"audience\": \"https://api.custom.eu\",\n    \"applicationPermissionsSettings\": {\n        \"claimEnabled\": true\n    }\n}");
Request request = new Request.Builder()
  .url("{{apiPath}}/environments/{{envID}}/resources/{{resourceID}}")
  .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}}/resources/{{resourceID}}",
  "method": "PUT",
  "timeout": 0,
  "headers": {
    "Content-Type": "application/json",
    "Authorization": "Bearer {{accessToken}}"
  },
  "data": JSON.stringify({
    "name": "CustomResource1709685712",
    "audience": "https://api.custom.eu",
    "applicationPermissionsSettings": {
      "claimEnabled": true
    }
  }),
};

$.ajax(settings).done(function (response) {
  console.log(response);
});
var request = require('request');
var options = {
  'method': 'PUT',
  'url': '{{apiPath}}/environments/{{envID}}/resources/{{resourceID}}',
  'headers': {
    'Content-Type': 'application/json',
    'Authorization': 'Bearer {{accessToken}}'
  },
  body: JSON.stringify({
    "name": "CustomResource1709685712",
    "audience": "https://api.custom.eu",
    "applicationPermissionsSettings": {
      "claimEnabled": true
    }
  })

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

url = "{{apiPath}}/environments/{{envID}}/resources/{{resourceID}}"

payload = json.dumps({
  "name": "CustomResource1709685712",
  "audience": "https://api.custom.eu",
  "applicationPermissionsSettings": {
    "claimEnabled": True
  }
})
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}}/resources/{{resourceID}}');
$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": "CustomResource1709685712",\n    "audience": "https://api.custom.eu",\n    "applicationPermissionsSettings": {\n        "claimEnabled": true\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}}/resources/{{resourceID}}")

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": "CustomResource1709685712",
  "audience": "https://api.custom.eu",
  "applicationPermissionsSettings": {
    "claimEnabled": true
  }
})

response = http.request(request)
puts response.read_body
let parameters = "{\n    \"name\": \"CustomResource1709685712\",\n    \"audience\": \"https://api.custom.eu\",\n    \"applicationPermissionsSettings\": {\n        \"claimEnabled\": true\n    }\n}"
let postData = parameters.data(using: .utf8)

var request = URLRequest(url: URL(string: "{{apiPath}}/environments/{{envID}}/resources/{{resourceID}}")!,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()

Example Response

200 OK

{
    "_links": {
        "self": {
            "href": "https://api.pingone.com/v1/environments/abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6/resources/9fd86709-4faf-4b59-b789-f46574ffb566"
        },
        "environment": {
            "href": "https://api.pingone.com/v1/environments/abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6"
        },
        "scopes": {
            "href": "https://api.pingone.com/v1/environments/abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6/resources/9fd86709-4faf-4b59-b789-f46574ffb566/scopes"
        },
        "attributes": {
            "href": "https://api.pingone.com/v1/environments/abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6/resources/9fd86709-4faf-4b59-b789-f46574ffb566/attributes"
        },
        "secret": {
            "href": "https://api.pingone.com/v1/environments/abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6/resources/9fd86709-4faf-4b59-b789-f46574ffb566/secret"
        }
    },
    "id": "9fd86709-4faf-4b59-b789-f46574ffb566",
    "environment": {
        "id": "abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6"
    },
    "name": "CustomResource1709685712",
    "type": "CUSTOM",
    "audience": "https://api.custom.eu",
    "createdAt": "2024-03-06T00:41:52.636Z",
    "updatedAt": "2024-03-06T23:13:50.696Z",
    "accessTokenValiditySeconds": 3600,
    "introspectEndpointAuthMethod": "CLIENT_SECRET_BASIC",
    "applicationPermissionsSettings": {
        "claimEnabled": true
    }
}