PingOne Platform APIs

Create Custom resource scope

   

POST {{apiPath}}/environments/{{envID}}/resources/{{resourceID}}/scopes

The POST {{apiPath}}/environments/{{envID}}/resources/{{resourceID}}/scopes operation adds a new custom resource scope. The request URL specifies the new scope’s associated environment ID and resource ID.

The request body must specify a value for the scope name property, and the name value must be unique within the specified environment resource.

Prerequisites

Request Model
Property Type Required?

description

String

Optional

name

String

Required

mappedClaims

String[]

Required

Refer to the Resource scopes data model for full property descriptions.

Headers

Authorization      Bearer {{accessToken}}

Content-Type      application/json

Body

raw ( application/json )

{
    "name": "Scope_{{$timestamp}}",
    "description": "My scope",
    "mappedClaims": [
        "{{resourceAttrID}}"
    ]
}

Example Request

  • cURL

  • C#

  • Go

  • HTTP

  • Java

  • jQuery

  • NodeJS

  • Python

  • PHP

  • Ruby

  • Swift

curl --location --globoff '{{apiPath}}/environments/{{envID}}/resources/{{resourceID}}/scopes' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer {{accessToken}}' \
--data '{
    "name": "Scope_{{$timestamp}}",
    "description": "My scope",
    "mappedClaims": [
        "{{resourceAttrID}}"
    ]
}'
var options = new RestClientOptions("{{apiPath}}/environments/{{envID}}/resources/{{resourceID}}/scopes")
{
  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" +
@"    ""name"": ""Scope_{{$timestamp}}""," + "\n" +
@"    ""description"": ""My scope""," + "\n" +
@"    ""mappedClaims"": [" + "\n" +
@"        ""{{resourceAttrID}}""" + "\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}}/scopes"
  method := "POST"

  payload := strings.NewReader(`{
    "name": "Scope_{{$timestamp}}",
    "description": "My scope",
    "mappedClaims": [
        "{{resourceAttrID}}"
    ]
}`)

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

{
    "name": "Scope_{{$timestamp}}",
    "description": "My scope",
    "mappedClaims": [
        "{{resourceAttrID}}"
    ]
}
OkHttpClient client = new OkHttpClient().newBuilder()
  .build();
MediaType mediaType = MediaType.parse("application/json");
RequestBody body = RequestBody.create(mediaType, "{\n    \"name\": \"Scope_{{$timestamp}}\",\n    \"description\": \"My scope\",\n    \"mappedClaims\": [\n        \"{{resourceAttrID}}\"\n    ]\n}");
Request request = new Request.Builder()
  .url("{{apiPath}}/environments/{{envID}}/resources/{{resourceID}}/scopes")
  .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}}/resources/{{resourceID}}/scopes",
  "method": "POST",
  "timeout": 0,
  "headers": {
    "Content-Type": "application/json",
    "Authorization": "Bearer {{accessToken}}"
  },
  "data": JSON.stringify({
    "name": "Scope_{{$timestamp}}",
    "description": "My scope",
    "mappedClaims": [
      "{{resourceAttrID}}"
    ]
  }),
};

$.ajax(settings).done(function (response) {
  console.log(response);
});
var request = require('request');
var options = {
  'method': 'POST',
  'url': '{{apiPath}}/environments/{{envID}}/resources/{{resourceID}}/scopes',
  'headers': {
    'Content-Type': 'application/json',
    'Authorization': 'Bearer {{accessToken}}'
  },
  body: JSON.stringify({
    "name": "Scope_{{$timestamp}}",
    "description": "My scope",
    "mappedClaims": [
      "{{resourceAttrID}}"
    ]
  })

};
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}}/scopes"

payload = json.dumps({
  "name": "Scope_{{$timestamp}}",
  "description": "My scope",
  "mappedClaims": [
    "{{resourceAttrID}}"
  ]
})
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}}/resources/{{resourceID}}/scopes');
$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    "name": "Scope_{{$timestamp}}",\n    "description": "My scope",\n    "mappedClaims": [\n        "{{resourceAttrID}}"\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}}/scopes")

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({
  "name": "Scope_{{\$timestamp}}",
  "description": "My scope",
  "mappedClaims": [
    "{{resourceAttrID}}"
  ]
})

response = http.request(request)
puts response.read_body
let parameters = "{\n    \"name\": \"Scope_{{$timestamp}}\",\n    \"description\": \"My scope\",\n    \"mappedClaims\": [\n        \"{{resourceAttrID}}\"\n    ]\n}"
let postData = parameters.data(using: .utf8)

var request = URLRequest(url: URL(string: "{{apiPath}}/environments/{{envID}}/resources/{{resourceID}}/scopes")!,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/resources/71ff29d5-c666-4348-b54e-c5b64f0a80b8/scopes/18725af1-828f-4e60-afc1-4a7092eb275a"
        },
        "resource": {
            "href": "https://api.pingone.com/v1/environments/abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6/resources/71ff29d5-c666-4348-b54e-c5b64f0a80b8"
        }
    },
    "id": "18725af1-828f-4e60-afc1-4a7092eb275a",
    "environment": {
        "id": "abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6"
    },
    "resource": {
        "id": "71ff29d5-c666-4348-b54e-c5b64f0a80b8"
    },
    "name": "Scope_1655153042",
    "description": "My scope",
    "mappedClaims": [
        "579dc6f8-bf83-43ae-816c-324506b5de21"
    ],
    "createdAt": "2022-06-13T20:44:02.066Z",
    "updatedAt": "2022-06-13T20:44:02.066Z"
}