Create Entitlement Binding

Link a request schema to a single app entitlement so the form is shown when requesting that entitlement.

POST /api/v1/request_schema_entitlement_binding

CreateEntitlementBinding

Go

package main

import(
	"context"
	"github.com/conductorone/conductorone-sdk-go/pkg/models/shared"
	conductoronesdkgo "github.com/conductorone/conductorone-sdk-go"
	"log"
)

func main() {
    ctx := context.Background()

    s := conductoronesdkgo.New(
        conductoronesdkgo.WithSecurity(shared.Security{
            BearerAuth: "<YOUR_BEARER_TOKEN_HERE>",
            Oauth: "<YOUR_OAUTH_HERE>",
        }),
    )

    res, err := s.RequestSchema.CreateEntitlementBinding(ctx, nil)
    if err != nil {
        log.Fatal(err)
    }
    if res.RequestSchemaServiceCreateEntitlementBindingResponse != nil {
        // handle response
    }
}

import { ConductoroneSDKTypescript } from "conductorone-sdk-typescript";

const conductoroneSDKTypescript = new ConductoroneSDKTypescript({
  security: {
    bearerAuth: "<YOUR_BEARER_TOKEN_HERE>",
    oauth: "<YOUR_OAUTH_HERE>",
  },
});

async function run() {
  const result = await conductoroneSDKTypescript.requestSchema.createEntitlementBinding();

  console.log(result);
}

run();

curl --request POST \
  --url https://{tenantDomain}.conductor.one/api/v1/request_schema_entitlement_binding \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "entitlementRef": {
    "appId": "<string>",
    "id": "<string>"
  },
  "requestSchemaId": "<string>"
}
'

import requests

url = "https://{tenantDomain}.conductor.one/api/v1/request_schema_entitlement_binding"

payload = {
    "entitlementRef": {
        "appId": "<string>",
        "id": "<string>"
    },
    "requestSchemaId": "<string>"
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    entitlementRef: {appId: '<string>', id: '<string>'},
    requestSchemaId: '<string>'
  })
};

fetch('https://{tenantDomain}.conductor.one/api/v1/request_schema_entitlement_binding', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://{tenantDomain}.conductor.one/api/v1/request_schema_entitlement_binding",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'entitlementRef' => [
        'appId' => '<string>',
        'id' => '<string>'
    ],
    'requestSchemaId' => '<string>'
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

HttpResponse<String> response = Unirest.post("https://{tenantDomain}.conductor.one/api/v1/request_schema_entitlement_binding")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"entitlementRef\": {\n    \"appId\": \"<string>\",\n    \"id\": \"<string>\"\n  },\n  \"requestSchemaId\": \"<string>\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://{tenantDomain}.conductor.one/api/v1/request_schema_entitlement_binding")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"entitlementRef\": {\n    \"appId\": \"<string>\",\n    \"id\": \"<string>\"\n  },\n  \"requestSchemaId\": \"<string>\"\n}"

response = http.request(request)
puts response.read_body

200

{
  "entitlementRef": {
    "appId": "<string>",
    "id": "<string>"
  },
  "requestSchemaId": "<string>"
}

Authorizations

Authorization · string · header · required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Authorization · string · header · required

This API uses OAuth2 with the Client Credential flow. Client Credentials must be sent in the BODY, not the headers. For an example of how to implement this, refer to the c1TokenSource.Token() function.

Body

application/json

The request message for creating a single entitlement binding on a request schema.

entitlementRef · App Entitlement Ref · object | null

The AppEntitlementRef message.

Show child attributes

requestSchemaId · string | null

The unique identifier of the request schema to bind the entitlement to.

Response

200 - application/json

The response message for creating a single entitlement binding.

The response message for creating a single entitlement binding.

entitlementRef · App Entitlement Ref · object | null

The AppEntitlementRef message.

Show child attributes

requestSchemaId · string | null

The unique identifier of the request schema the entitlement was bound to.