PingOne Platform APIs

Update Grant

   

PUT {{apiPath}}/environments/{{envID}}/applications/{{appID}}/grants/{{grantID}}

To update a property value associated with a selected application resource grant, use the PUT {{apiPath}}/environments/{{envID}}/applications/{{appID}}/grants/{{grantID}} operation to modify the attribute values for the specified grant resource. For example, you can change the scopes attribute value to add another OIDC scope ID.

The resource.id property must be include in the request body, and must be the same resource.id as that associated with the specified grant.

Prerequisites

Request Model

Refer to the Application Resource Grants for complete descriptions.

Property Type Required?

resource.id

String

N/A

scopes.id

String[]

Required

Headers

Authorization      Bearer {{accessToken}}

Content-Type      application/json

Body

raw ( application/json )

{
    "resource": {
        "id": "{{resourceID}}"
    },
    "scopes": [
        {
            "id": "{{scopeID}}"
        },
        {
            "id": "{{scopeID_2}}"
        }
    ]
}

Example Request

  • cURL

  • C#

  • Go

  • HTTP

  • Java

  • jQuery

  • NodeJS

  • Python

  • PHP

  • Ruby

  • Swift

curl --location --globoff --request PUT '{{apiPath}}/environments/{{envID}}/applications/{{appID}}/grants/{{grantID}}' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer {{accessToken}}' \
--data '{
    "resource": {
        "id": "{{resourceID}}"
    },
    "scopes": [
        {
            "id": "{{scopeID}}"
        },
        {
            "id": "{{scopeID_2}}"
        }
    ]
}'
var options = new RestClientOptions("{{apiPath}}/environments/{{envID}}/applications/{{appID}}/grants/{{grantID}}")
{
  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" +
@"    ""resource"": {" + "\n" +
@"        ""id"": ""{{resourceID}}""" + "\n" +
@"    }," + "\n" +
@"    ""scopes"": [" + "\n" +
@"        {" + "\n" +
@"            ""id"": ""{{scopeID}}""" + "\n" +
@"        }," + "\n" +
@"        {" + "\n" +
@"            ""id"": ""{{scopeID_2}}""" + "\n" +
@"        }" + "\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}}/applications/{{appID}}/grants/{{grantID}}"
  method := "PUT"

  payload := strings.NewReader(`{
    "resource": {
        "id": "{{resourceID}}"
    },
    "scopes": [
        {
            "id": "{{scopeID}}"
        },
        {
            "id": "{{scopeID_2}}"
        }
    ]
}`)

  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}}/applications/{{appID}}/grants/{{grantID}} HTTP/1.1
Host: {{apiPath}}
Content-Type: application/json
Authorization: Bearer {{accessToken}}

{
    "resource": {
        "id": "{{resourceID}}"
    },
    "scopes": [
        {
            "id": "{{scopeID}}"
        },
        {
            "id": "{{scopeID_2}}"
        }
    ]
}
OkHttpClient client = new OkHttpClient().newBuilder()
  .build();
MediaType mediaType = MediaType.parse("application/json");
RequestBody body = RequestBody.create(mediaType, "{\n    \"resource\": {\n        \"id\": \"{{resourceID}}\"\n    },\n    \"scopes\": [\n        {\n            \"id\": \"{{scopeID}}\"\n        },\n        {\n            \"id\": \"{{scopeID_2}}\"\n        }\n    ]\n}");
Request request = new Request.Builder()
  .url("{{apiPath}}/environments/{{envID}}/applications/{{appID}}/grants/{{grantID}}")
  .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}}/applications/{{appID}}/grants/{{grantID}}",
  "method": "PUT",
  "timeout": 0,
  "headers": {
    "Content-Type": "application/json",
    "Authorization": "Bearer {{accessToken}}"
  },
  "data": JSON.stringify({
    "resource": {
      "id": "{{resourceID}}"
    },
    "scopes": [
      {
        "id": "{{scopeID}}"
      },
      {
        "id": "{{scopeID_2}}"
      }
    ]
  }),
};

$.ajax(settings).done(function (response) {
  console.log(response);
});
var request = require('request');
var options = {
  'method': 'PUT',
  'url': '{{apiPath}}/environments/{{envID}}/applications/{{appID}}/grants/{{grantID}}',
  'headers': {
    'Content-Type': 'application/json',
    'Authorization': 'Bearer {{accessToken}}'
  },
  body: JSON.stringify({
    "resource": {
      "id": "{{resourceID}}"
    },
    "scopes": [
      {
        "id": "{{scopeID}}"
      },
      {
        "id": "{{scopeID_2}}"
      }
    ]
  })

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

url = "{{apiPath}}/environments/{{envID}}/applications/{{appID}}/grants/{{grantID}}"

payload = json.dumps({
  "resource": {
    "id": "{{resourceID}}"
  },
  "scopes": [
    {
      "id": "{{scopeID}}"
    },
    {
      "id": "{{scopeID_2}}"
    }
  ]
})
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}}/applications/{{appID}}/grants/{{grantID}}');
$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    "resource": {\n        "id": "{{resourceID}}"\n    },\n    "scopes": [\n        {\n            "id": "{{scopeID}}"\n        },\n        {\n            "id": "{{scopeID_2}}"\n        }\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}}/applications/{{appID}}/grants/{{grantID}}")

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({
  "resource": {
    "id": "{{resourceID}}"
  },
  "scopes": [
    {
      "id": "{{scopeID}}"
    },
    {
      "id": "{{scopeID_2}}"
    }
  ]
})

response = http.request(request)
puts response.read_body
let parameters = "{\n    \"resource\": {\n        \"id\": \"{{resourceID}}\"\n    },\n    \"scopes\": [\n        {\n            \"id\": \"{{scopeID}}\"\n        },\n        {\n            \"id\": \"{{scopeID_2}}\"\n        }\n    ]\n}"
let postData = parameters.data(using: .utf8)

var request = URLRequest(url: URL(string: "{{apiPath}}/environments/{{envID}}/applications/{{appID}}/grants/{{grantID}}")!,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/applications/cad1c86d-a6c8-4e61-b15f-8ff452698fa8/grants/90c0b478-27fb-4dea-abfb-88ff342bf973"
        },
        "environment": {
            "href": "https://api.pingone.com/v1/environments/abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6"
        },
        "application": {
            "href": "https://api.pingone.com/v1/environments/abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6/applications/cad1c86d-a6c8-4e61-b15f-8ff452698fa8"
        },
        "resource": {
            "href": "https://api.pingone.com/v1/environments/abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6/resources/e303cdcd-2fce-4181-90a9-ff945280ae4a"
        }
    },
    "id": "90c0b478-27fb-4dea-abfb-88ff342bf973",
    "environment": {
        "id": "abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6"
    },
    "resource": {
        "id": "e303cdcd-2fce-4181-90a9-ff945280ae4a"
    },
    "application": {
        "id": "cad1c86d-a6c8-4e61-b15f-8ff452698fa8"
    },
    "scopes": [
        {
            "id": "c61ff2ab-a737-4414-980b-623ffb940615"
        },
        {
            "id": "b59704a4-09d8-472c-ac67-2dd8174d772f"
        }
    ],
    "createdAt": "2019-08-13T19:39:58.450Z",
    "updatedAt": "2021-09-24T15:43:19.846Z"
}