PingOne Platform APIs

Update Application Permission

 

PUT {{apiPath}}/environments/{{envID}}/applicationResources/{{appResourceID}}/permissions/{{appResourcePermissionID}}

The PUT {{apiPath}}/environments/{{envID}}/applicationResources/{{appResourceID}}/permissions/{{appResourcePermissionID}} modifies the attributes of the specified application resource permission.

Request Model

For complete descriptions, refer to Application resources permissions data model.

Property Type? Required?

action

String

Required

description

String

Optional

Headers

Authorization      Bearer {{accessToken}}

Content-Type      application/json

Body

raw ( application/json )

{
    "description": "A customer account.",
    "action": "update"
}

Example Request

  • cURL

  • C#

  • Go

  • HTTP

  • Java

  • jQuery

  • NodeJS

  • Python

  • PHP

  • Ruby

  • Swift

curl --location --globoff --request PUT '{{apiPath}}/environments/{{envID}}/applicationResources/{{appResourceID}}/permissions/{{appResourcePermissionID}}' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer {{accessToken}}' \
--data '{
    "description": "A customer account.",
    "action": "update"
}'
var options = new RestClientOptions("{{apiPath}}/environments/{{envID}}/applicationResources/{{appResourceID}}/permissions/{{appResourcePermissionID}}")
{
  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" +
@"    ""description"": ""A customer account.""," + "\n" +
@"    ""action"": ""update""" + "\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}}/applicationResources/{{appResourceID}}/permissions/{{appResourcePermissionID}}"
  method := "PUT"

  payload := strings.NewReader(`{
    "description": "A customer account.",
    "action": "update"
}`)

  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}}/applicationResources/{{appResourceID}}/permissions/{{appResourcePermissionID}} HTTP/1.1
Host: {{apiPath}}
Content-Type: application/json
Authorization: Bearer {{accessToken}}

{
    "description": "A customer account.",
    "action": "update"
}
OkHttpClient client = new OkHttpClient().newBuilder()
  .build();
MediaType mediaType = MediaType.parse("application/json");
RequestBody body = RequestBody.create(mediaType, "{\n    \"description\": \"A customer account.\",\n    \"action\": \"update\"\n}");
Request request = new Request.Builder()
  .url("{{apiPath}}/environments/{{envID}}/applicationResources/{{appResourceID}}/permissions/{{appResourcePermissionID}}")
  .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}}/applicationResources/{{appResourceID}}/permissions/{{appResourcePermissionID}}",
  "method": "PUT",
  "timeout": 0,
  "headers": {
    "Content-Type": "application/json",
    "Authorization": "Bearer {{accessToken}}"
  },
  "data": JSON.stringify({
    "description": "A customer account.",
    "action": "update"
  }),
};

$.ajax(settings).done(function (response) {
  console.log(response);
});
var request = require('request');
var options = {
  'method': 'PUT',
  'url': '{{apiPath}}/environments/{{envID}}/applicationResources/{{appResourceID}}/permissions/{{appResourcePermissionID}}',
  'headers': {
    'Content-Type': 'application/json',
    'Authorization': 'Bearer {{accessToken}}'
  },
  body: JSON.stringify({
    "description": "A customer account.",
    "action": "update"
  })

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

url = "{{apiPath}}/environments/{{envID}}/applicationResources/{{appResourceID}}/permissions/{{appResourcePermissionID}}"

payload = json.dumps({
  "description": "A customer account.",
  "action": "update"
})
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}}/applicationResources/{{appResourceID}}/permissions/{{appResourcePermissionID}}');
$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    "description": "A customer account.",\n    "action": "update"\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}}/applicationResources/{{appResourceID}}/permissions/{{appResourcePermissionID}}")

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({
  "description": "A customer account.",
  "action": "update"
})

response = http.request(request)
puts response.read_body
let parameters = "{\n    \"description\": \"A customer account.\",\n    \"action\": \"update\"\n}"
let postData = parameters.data(using: .utf8)

var request = URLRequest(url: URL(string: "{{apiPath}}/environments/{{envID}}/applicationResources/{{appResourceID}}/permissions/{{appResourcePermissionID}}")!,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/applicationResources/9fc45050-4e39-4f98-9de5-dbff01659a14/permissions/47ab2789-3f3d-4f25-b5bf-efc9f8d363b1"
        },
        "environment": {
            "href": "https://api.pingone.com/v1/environments/abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6"
        },
        "resource": {
            "href": "https://api.pingone.com/v1/environments/abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6/applicationResources/9fc45050-4e39-4f98-9de5-dbff01659a14"
        }
    },
    "environment": {
        "id": "abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6"
    },
    "id": "47ab2789-3f3d-4f25-b5bf-efc9f8d363b1",
    "action": "update",
    "resource": {
        "id": "9fc45050-4e39-4f98-9de5-dbff01659a14",
        "name": "portfolios"
    },
    "description": "A customer account.",
    "key": "portfolios:update"
}