Update Access for Folders

POST /v2/organizations/folders/access/update

Update Access for Folders

cURL

curl --request POST \
  --url https://api.velt.dev/v2/organizations/folders/access/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": {
    "organizationId": "<string>",
    "folderIds": [
      "<string>"
    ],
    "accessType": "<string>",
    "inheritFromParent": true
  }
}
'

{
  "result": {
    "status": "success",
    "message": "Updated access for folders successfully.",
    "data": {
      "yourFolderId": {
        "success": true,
        "accessType": "organizationPrivate",
        "message": "Folder access type updated."
      }
    }
  }
}

Use this API to update the access type for a single or multiple folders at once.

You can update the default access type for all the folders associated with your API Key in console.

Endpoint

https://api.velt.dev/v2/organizations/folders/access/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

organizationId · string · required

Organization ID

folderIds · string[] · required

Array of Folder IDs

accessType · string · default: "public" · required

Access type for the folders. Allowed values: organizationPrivate, restricted, public. Learn more.

inheritFromParent · boolean

Configure the folder to inherit access permissions from its parent folder. When set to true, the folder automatically inherits all access settings from its parent.

Example Requests

1. Update folder access type

{
  "data": {
    "organizationId": "yourOrganizationId",
    "folderIds": ["yourFolderId1, yourFolderId2"],
    "accessType": "organizationPrivate"
  }
}

2. Configure folder to inherit access from parent

{
  "data": {
    "organizationId": "yourOrganizationId",
    "folderIds": ["yourFolderId1"],
    "inheritFromParent": true
  }
}

Response

Success Response

{
  "result": {
    "status": "success",
    "message": "Updated access for folders successfully.",
    "data": {
      "yourFolderId": {
        "success": true,
        "accessType": "organizationPrivate",
        "message": "Folder access type updated."
      }
    }
  }
}

Success Inherit Access From Parent Response

{
    "result": {
        "status": "success",
        "message": "Folder access type updated.",
        "data": {
            "folder1": {
                "success": true,
                "accessType": null,
                "inheritFromParent": true,
                "message": "Folder access type updated."
            }
        }
    }
}

Failure Response

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

{
  "result": {
    "status": "success",
    "message": "Updated access for folders successfully.",
    "data": {
      "yourFolderId": {
        "success": true,
        "accessType": "organizationPrivate",
        "message": "Folder access type updated."
      }
    }
  }
}