Skip to main content
POST
/
v2
/
workspace
/
permissionproviderconfig
/
update
Update Permission Provider Config
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>"
    }
  }
}
'
{
  "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

​
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."
  }
}