--- title: "Step 4: Create a custom resource scope" component: pingone-api page_id: pingone-api:workflow-library:pingone-authorize/show-permissions-in-token/environment-configuration/step-4-create-custom-resource-scope canonical_url: https://developer.pingidentity.com/pingone-api/workflow-library/pingone-authorize/show-permissions-in-token/environment-configuration/step-4-create-custom-resource-scope.html section_ids: headers: Headers body: Body example-request: Example Request example-response: Example Response --- # Step 4: Create a custom resource scope ##     ```none POST {{apiPath}}/v1/environments/{{envID}}/resources/{{customResourceID}}/scopes ``` In this step, you create a scope for the custom resource that you apply to the resource access grant. The `POST {{apiPath}}/v1/environments/{{envID}}/resources/{{resourceID}}/scopes` creates the custom scope associated with the custom resource entity ID specified in the request URL. The response returns the scope ID, which is needed to cereate the resource access grant. ### Headers Authorization      Bearer {{accessToken}} Content-Type      application/json ### Body raw ( application/json ) ```json { "name": "CustomScope_{{$timestamp}}", "description": "My scope" } ``` ## ### Example Request * cURL * C# * Go * HTTP * Java * jQuery * NodeJS * Python * PHP * Ruby * Swift ```shell curl --location --globoff '{{apiPath}}/v1/environments/{{envID}}/resources/{{customResourceID}}/scopes' \ --header 'Content-Type: application/json' \ --header 'Authorization: Bearer {{accessToken}}' \ --data '{ "name": "CustomScope_{{$timestamp}}", "description": "My scope" }' ``` ```csharp var options = new RestClientOptions("{{apiPath}}/v1/environments/{{envID}}/resources/{{customResourceID}}/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"": ""CustomScope_{{$timestamp}}""," + "\n" + @" ""description"": ""My scope""" + "\n" + @"}"; request.AddStringBody(body, DataFormat.Json); RestResponse response = await client.ExecuteAsync(request); Console.WriteLine(response.Content); ``` ```golang package main import ( "fmt" "strings" "net/http" "io" ) func main() { url := "{{apiPath}}/v1/environments/{{envID}}/resources/{{customResourceID}}/scopes" method := "POST" payload := strings.NewReader(`{ "name": "CustomScope_{{$timestamp}}", "description": "My scope" }`) 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)) } ``` ```http POST /v1/environments/{{envID}}/resources/{{customResourceID}}/scopes HTTP/1.1 Host: {{apiPath}} Content-Type: application/json Authorization: Bearer {{accessToken}} { "name": "CustomScope_{{$timestamp}}", "description": "My scope" } ``` ```java OkHttpClient client = new OkHttpClient().newBuilder() .build(); MediaType mediaType = MediaType.parse("application/json"); RequestBody body = RequestBody.create(mediaType, "{\n \"name\": \"CustomScope_{{$timestamp}}\",\n \"description\": \"My scope\"\n}"); Request request = new Request.Builder() .url("{{apiPath}}/v1/environments/{{envID}}/resources/{{customResourceID}}/scopes") .method("POST", body) .addHeader("Content-Type", "application/json") .addHeader("Authorization", "Bearer {{accessToken}}") .build(); Response response = client.newCall(request).execute(); ``` ```javascript var settings = { "url": "{{apiPath}}/v1/environments/{{envID}}/resources/{{customResourceID}}/scopes", "method": "POST", "timeout": 0, "headers": { "Content-Type": "application/json", "Authorization": "Bearer {{accessToken}}" }, "data": JSON.stringify({ "name": "CustomScope_{{$timestamp}}", "description": "My scope" }), }; $.ajax(settings).done(function (response) { console.log(response); }); ``` ```javascript var request = require('request'); var options = { 'method': 'POST', 'url': '{{apiPath}}/v1/environments/{{envID}}/resources/{{customResourceID}}/scopes', 'headers': { 'Content-Type': 'application/json', 'Authorization': 'Bearer {{accessToken}}' }, body: JSON.stringify({ "name": "CustomScope_{{$timestamp}}", "description": "My scope" }) }; request(options, function (error, response) { if (error) throw new Error(error); console.log(response.body); }); ``` ```python import requests import json url = "{{apiPath}}/v1/environments/{{envID}}/resources/{{customResourceID}}/scopes" payload = json.dumps({ "name": "CustomScope_{{$timestamp}}", "description": "My scope" }) headers = { 'Content-Type': 'application/json', 'Authorization': 'Bearer {{accessToken}}' } response = requests.request("POST", url, headers=headers, data=payload) print(response.text) ``` ```php setUrl('{{apiPath}}/v1/environments/{{envID}}/resources/{{customResourceID}}/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": "CustomScope_{{$timestamp}}",\n "description": "My scope"\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(); } ``` ```ruby require "uri" require "json" require "net/http" url = URI("{{apiPath}}/v1/environments/{{envID}}/resources/{{customResourceID}}/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": "CustomScope_{{\$timestamp}}", "description": "My scope" }) response = http.request(request) puts response.read_body ``` ```swift let parameters = "{\n \"name\": \"CustomScope_{{$timestamp}}\",\n \"description\": \"My scope\"\n}" let postData = parameters.data(using: .utf8) var request = URLRequest(url: URL(string: "{{apiPath}}/v1/environments/{{envID}}/resources/{{customResourceID}}/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 ```json { "_links": { "self": { "href": "https://api.pingone.com/v1/environments/abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6/resources/5de5451f-47e8-44f5-946d-6d8936685704/scopes/82f89459-1a10-42eb-9cf8-86fba8290cb7" }, "resource": { "href": "https://api.pingone.com/v1/environments/abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6/resources/5de5451f-47e8-44f5-946d-6d8936685704" } }, "id": "82f89459-1a10-42eb-9cf8-86fba8290cb7", "environment": { "id": "abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6" }, "resource": { "id": "5de5451f-47e8-44f5-946d-6d8936685704" }, "name": "CustomScope_1712950384", "description": "My scope", "createdAt": "2024-04-12T19:33:04.578Z", "updatedAt": "2024-04-12T19:33:04.578Z" } ```