Remove Permissions

POST /v2/auth/permissions/remove

Remove Permissions

cURL

curl --request POST \
  --url https://api.velt.dev/v2/auth/permissions/remove \
  --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": {
    "userId": "<string>",
    "permissions": {
      "resources": [
        {
          "type": "<string>",
          "id": "<string>",
          "organizationId": "<string>"
        }
      ]
    }
  }
}
'

{
  "result": {
    "status": "success",
    "message": "Permissions removed successfully."
  }
}

Use this API to remove permissions from a user for specific resources like organizations or documents.

This endpoint allows you to revoke access for a user from one or more resources.

Endpoint

POST https://api.velt.dev/v2/auth/permissions/remove

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

userId · string · required

The ID of the user from whom to remove permissions.

permissions · object · required

Show properties

resources · object[] · required

An array of resource objects from which to remove user permissions.

Show Resource object

type · string · required

The type of resource. Must be one of: organization, document, or folder.

id · string · required

The ID of the resource.

organizationId · string

The ID of the organization. Required if type is document.

Example Requests

Remove permissions from an organization and a document

{
  "data": {
    "userId": "USER_ID",
    "permissions": {
      "resources": [
        {
          "type": "organization",
          "id": "ORGANIZATION_ID"
        },
        {
          "type": "document",
          "id": "DOCUMENT_ID",
          "organizationId": "ORGANIZATION_ID"
        }
      ]
    }
  }
}

Response

Success Response

{
  "result": {
    "status": "success",
    "message": "Permissions removed successfully."
  }
}

Failure Response

{
  "error": {
    "message": "ERROR_MESSAGE",
    "status": "INVALID_ARGUMENT"
  }
}

{
  "result": {
    "status": "success",
    "message": "Permissions removed successfully."
  }
}