Update Permission Provider Config

POST /v2/workspace/permissionproviderconfig/update

Update Permission Provider Config

cURL

curl --request POST \
  --url https://api.velt.dev/v2/workspace/permissionproviderconfig/update \
  --header 'Content-Type: application/json' \
  --header 'x-velt-api-key: <x-velt-api-key>' \
  --header 'x-velt-auth-token: <x-velt-auth-token>' \
  --data '
{
  "data": {
    "usePermissionProvider": true,
    "permissionProviderConfig": {
      "permissionProviderUrl": "<string>",
      "authToken": "<string>"
    }
  }
}
'

import requests

url = "https://api.velt.dev/v2/workspace/permissionproviderconfig/update"

payload = { "data": {
        "usePermissionProvider": True,
        "permissionProviderConfig": {
            "permissionProviderUrl": "<string>",
            "authToken": "<string>"
        }
    } }
headers = {
    "x-velt-api-key": "<x-velt-api-key>",
    "x-velt-auth-token": "<x-velt-auth-token>",
    "Content-Type": "application/json"
}

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

print(response.text)

const options = {
  method: 'POST',
  headers: {
    'x-velt-api-key': '<x-velt-api-key>',
    'x-velt-auth-token': '<x-velt-auth-token>',
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({
    data: {
      usePermissionProvider: true,
      permissionProviderConfig: {permissionProviderUrl: '<string>', authToken: '<string>'}
    }
  })
};

fetch('https://api.velt.dev/v2/workspace/permissionproviderconfig/update', 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://api.velt.dev/v2/workspace/permissionproviderconfig/update",
  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([
    'data' => [
        'usePermissionProvider' => true,
        'permissionProviderConfig' => [
                'permissionProviderUrl' => '<string>',
                'authToken' => '<string>'
        ]
    ]
  ]),
  CURLOPT_HTTPHEADER => [
    "Content-Type: application/json",
    "x-velt-api-key: <x-velt-api-key>",
    "x-velt-auth-token: <x-velt-auth-token>"
  ],
]);

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

curl_close($curl);

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

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.velt.dev/v2/workspace/permissionproviderconfig/update"

	payload := strings.NewReader("{\n  \"data\": {\n    \"usePermissionProvider\": true,\n    \"permissionProviderConfig\": {\n      \"permissionProviderUrl\": \"<string>\",\n      \"authToken\": \"<string>\"\n    }\n  }\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("x-velt-api-key", "<x-velt-api-key>")
	req.Header.Add("x-velt-auth-token", "<x-velt-auth-token>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://api.velt.dev/v2/workspace/permissionproviderconfig/update")
  .header("x-velt-api-key", "<x-velt-api-key>")
  .header("x-velt-auth-token", "<x-velt-auth-token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"data\": {\n    \"usePermissionProvider\": true,\n    \"permissionProviderConfig\": {\n      \"permissionProviderUrl\": \"<string>\",\n      \"authToken\": \"<string>\"\n    }\n  }\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.velt.dev/v2/workspace/permissionproviderconfig/update")

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

request = Net::HTTP::Post.new(url)
request["x-velt-api-key"] = '<x-velt-api-key>'
request["x-velt-auth-token"] = '<x-velt-auth-token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"data\": {\n    \"usePermissionProvider\": true,\n    \"permissionProviderConfig\": {\n      \"permissionProviderUrl\": \"<string>\",\n      \"authToken\": \"<string>\"\n    }\n  }\n}"

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

{
  "result": {
    "status": "success",
    "message": "Permission provider configuration updated successfully."
  }
}

Use this API to update the permission provider configuration for a workspace. At least one of usePermissionProvider or permissionProviderConfig must be provided. The config is merged with the existing value, so e.g. the authToken is preserved when only the URL changes.

This endpoint uses API-key-level auth: pass x-velt-api-key and x-velt-auth-token as headers. You can obtain these from the Get Auth Tokens endpoint.

Defaults on first enable. If you enable the provider (usePermissionProvider: true) and no permissionProviderConfig exists yet, an empty config is seeded (permissionProviderUrl and authToken set to empty strings) and returned in the response data. Any permissionProviderConfig values you send in the same request are merged on top.

Endpoint

POST https://api.velt.dev/v2/workspace/permissionproviderconfig/update

Headers

x-velt-api-key · string · required

Your API key.

x-velt-auth-token · string · required

Your Auth Token.

Body

Params

data · object · required

Show properties

usePermissionProvider · boolean

Whether to enable the permission provider.

permissionProviderConfig · object

Permission provider configuration object.

Show properties

permissionProviderUrl · string

Provider URL. Must be an empty string (to clear the value) or a valid http/https URL. Any other value is rejected.

authToken · string

Auth token sent to the permission provider.

Example Request

{
  "data": {
    "usePermissionProvider": true,
    "permissionProviderConfig": {
      "permissionProviderUrl": "https://example.com/permissions",
      "authToken": "provider_auth_token_here"
    }
  }
}

Example Response

Success Response

{
  "result": {
    "status": "success",
    "message": "Permission provider configuration updated successfully."
  }
}

Failure Response

If permissionProviderUrl is not empty and not a valid http(s) URL

{
  "error": {
    "status": "INVALID_ARGUMENT",
    "message": "Please enter a valid URL"
  }
}

{
  "result": {
    "status": "success",
    "message": "Permission provider configuration updated successfully."
  }
}