PingOne Platform APIs

Step 5: Assign a resource grant to the web application

   

POST {{apiPath}}/environments/{{envID}}/applications/{{webApp4MfaId}}/grants

After retrieving the resource ID in Step 3 and the scope ID that you need in Step 4, you can use the POST {{apiPath}}/environments/{{envID}}/applications/{{appID}}/grants operation to create a new resource access grant for the application.

The body of the request specifies the ID for the resource property (openid) and the ID for the openid scope that you will assign to the application’s resource grant (profile).

The response data shows the resource grant ID and the scope associated with the grant.

Headers

Authorization      Bearer {{accessToken}}

Content-Type      application/json

Body

raw ( application/json )

{
    "resource": {
        "id": "{{openidResourceID}}"
    },
    "scopes": [
        {
            "id": "{{oidcProfileID}}"
        }
    ]
}

Example Request

  • cURL

  • C#

  • Go

  • HTTP

  • Java

  • jQuery

  • NodeJS

  • Python

  • PHP

  • Ruby

  • Swift

curl --location --globoff '{{apiPath}}/environments/{{envID}}/applications/{{webApp4MfaId}}/grants' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer {{accessToken}}' \
--data '{
    "resource": {
        "id": "{{openidResourceID}}"
    },
    "scopes": [
        {
            "id": "{{oidcProfileID}}"
        }
    ]
}'
var options = new RestClientOptions("{{apiPath}}/environments/{{envID}}/applications/{{webApp4MfaId}}/grants")
{
  MaxTimeout = -1,
};
var client = new RestClient(options);
var request = new RestRequest("", Method.Post);
request.AddHeader("Content-Type", "application/json");
request.AddHeader("Authorization", "Bearer {{accessToken}}");
var body = @"{" + "\n" +
@"    ""resource"": {" + "\n" +
@"        ""id"": ""{{openidResourceID}}""" + "\n" +
@"    }," + "\n" +
@"    ""scopes"": [" + "\n" +
@"        {" + "\n" +
@"            ""id"": ""{{oidcProfileID}}""" + "\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/{{webApp4MfaId}}/grants"
  method := "POST"

  payload := strings.NewReader(`{
    "resource": {
        "id": "{{openidResourceID}}"
    },
    "scopes": [
        {
            "id": "{{oidcProfileID}}"
        }
    ]
}`)

  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))
}
POST /environments/{{envID}}/applications/{{webApp4MfaId}}/grants HTTP/1.1
Host: {{apiPath}}
Content-Type: application/json
Authorization: Bearer {{accessToken}}

{
    "resource": {
        "id": "{{openidResourceID}}"
    },
    "scopes": [
        {
            "id": "{{oidcProfileID}}"
        }
    ]
}
OkHttpClient client = new OkHttpClient().newBuilder()
  .build();
MediaType mediaType = MediaType.parse("application/json");
RequestBody body = RequestBody.create(mediaType, "{\n    \"resource\": {\n        \"id\": \"{{openidResourceID}}\"\n    },\n    \"scopes\": [\n        {\n            \"id\": \"{{oidcProfileID}}\"\n        }\n    ]\n}");
Request request = new Request.Builder()
  .url("{{apiPath}}/environments/{{envID}}/applications/{{webApp4MfaId}}/grants")
  .method("POST", body)
  .addHeader("Content-Type", "application/json")
  .addHeader("Authorization", "Bearer {{accessToken}}")
  .build();
Response response = client.newCall(request).execute();
var settings = {
  "url": "{{apiPath}}/environments/{{envID}}/applications/{{webApp4MfaId}}/grants",
  "method": "POST",
  "timeout": 0,
  "headers": {
    "Content-Type": "application/json",
    "Authorization": "Bearer {{accessToken}}"
  },
  "data": JSON.stringify({
    "resource": {
      "id": "{{openidResourceID}}"
    },
    "scopes": [
      {
        "id": "{{oidcProfileID}}"
      }
    ]
  }),
};

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

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

url = "{{apiPath}}/environments/{{envID}}/applications/{{webApp4MfaId}}/grants"

payload = json.dumps({
  "resource": {
    "id": "{{openidResourceID}}"
  },
  "scopes": [
    {
      "id": "{{oidcProfileID}}"
    }
  ]
})
headers = {
  'Content-Type': 'application/json',
  'Authorization': 'Bearer {{accessToken}}'
}

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

print(response.text)
<?php
require_once 'HTTP/Request2.php';
$request = new HTTP_Request2();
$request->setUrl('{{apiPath}}/environments/{{envID}}/applications/{{webApp4MfaId}}/grants');
$request->setMethod(HTTP_Request2::METHOD_POST);
$request->setConfig(array(
  'follow_redirects' => TRUE
));
$request->setHeader(array(
  'Content-Type' => 'application/json',
  'Authorization' => 'Bearer {{accessToken}}'
));
$request->setBody('{\n    "resource": {\n        "id": "{{openidResourceID}}"\n    },\n    "scopes": [\n        {\n            "id": "{{oidcProfileID}}"\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/{{webApp4MfaId}}/grants")

http = Net::HTTP.new(url.host, url.port);
request = Net::HTTP::Post.new(url)
request["Content-Type"] = "application/json"
request["Authorization"] = "Bearer {{accessToken}}"
request.body = JSON.dump({
  "resource": {
    "id": "{{openidResourceID}}"
  },
  "scopes": [
    {
      "id": "{{oidcProfileID}}"
    }
  ]
})

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

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

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

201 Created

{
    "_links": {
        "self": {
            "href": "https://api.pingone.com/v1/environments/abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6/applications/f028fa12-cef2-4efd-bcaa-a91e6803bdcc/grants/0daeb78c-24b3-4007-a9e3-f641b22d8fea"
        },
        "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/f028fa12-cef2-4efd-bcaa-a91e6803bdcc"
        },
        "resource": {
            "href": "https://api.pingone.com/v1/environments/abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6/resources/71ff29d5-c666-4348-b54e-c5b64f0a80b8"
        }
    },
    "id": "0daeb78c-24b3-4007-a9e3-f641b22d8fea",
    "environment": {
        "id": "abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6"
    },
    "resource": {
        "id": "71ff29d5-c666-4348-b54e-c5b64f0a80b8"
    },
    "application": {
        "id": "f028fa12-cef2-4efd-bcaa-a91e6803bdcc"
    },
    "scopes": [
        {
            "id": "a7952e0a-57f2-4922-85cc-7e791e2e70b1"
        }
    ],
    "createdAt": "2021-08-04T22:58:09.029Z",
    "updatedAt": "2021-08-04T22:58:09.029Z"
}