/api/v1/db_info

Read-only permission probe for object creation. For a given objecttype, pool_id and tag_ids combination it reports where the requesting user may create objects, returning _available_objecttypes, _available_masks and _available_tags. No object is created.

POST /db_info/create

post

Retrieve information about if objects can be created in a specific object type and pool configuration. Tags can also be provided to perform the check.

• With no further parameters, object types are returned where the user can create new objects: for a pooled objecttype this checks each pool for the create right; a non-pool objecttype is listed if it grants the create right directly.
• With objecttype set, a list of pool_ids is returned alongside the object type.
• With tag_ids unsent the server uses the default tag set for the objecttype/pool combination to check the rights.
• With tag_ids provided, these ids are used to check the rights.
• With tag_ids set to null, the rights are checked without tag filters.

Authorizations

BearerAuthAccessTokenQueryFylrAuthHeader

AuthorizationstringRequired

Access token in the Authorization header: Authorization: Bearer <token>.

Header parameters

x-fylr-authorizationstringOptional

The access token in form of Bearer <token>. You can also use authorization which does the same. authorization is looked at first.

authorizationstringOptional

The access token in form of Bearer <token>.

Body

application/json

objecttypestringOptional

The object type to check the create permissions for. If omitted, the check will include all object types.

pool_idintegerOptional

The ID of the pool to check the permissions for.

tag_idsinteger[] · nullableOptional

List of tag IDs which are assumed for the new object. If omitted, the check will include the default tags. If set to null, the tags check will be omitted. This can be useful if only a certain combination (which is not the default combination) of tags enables permissions for the user. An id that matches no tag returns code TagNotFound; an id that exists but is not enabled for the objecttype/pool returns code TagNotEnabled. These two codes are raised only by db_info/create.

Responses

200

An object describing the possibilites to create an object for the user.

application/json

400

The permission check could not be performed. When present, the code field of the response identifies the specific reason; not every 400 carries a stable code (input-validation failures are returned as generic messages).

application/json

401

No authenticated user. The request must carry a valid access token.

Differs from easydb 5: a missing/invalid session is reported as 401 (UnauthorizedError); easydb 5 documents the unauthenticated case as a 400.

application/json

{
  "_available_objecttypes": [
    {
      "_id": 27,
      "name": "nested",
      "pool_ids": [
        1,
        2,
        3,
        4
      ]
    }
  ],
  "_available_masks": [
    {
      "_id": 11,
      "name": "nested__all_fields"
    }
  ],
  "_available_tags": [
    {
      "_id": 1,
      "is_default": true
    }
  ]
}

POST /db_info/update

post

Retrieve information about how objects can be updated using a new pool or tags.

• An objecttype and object_ids must be provided. If either is missing, the request fails with a generic 400.
• If a pool change is planned, the pool_id as the new pool ID can be sent. All permission compilations are done with the new pool ID, except for the unlink permission which is checked against the current pool ID of the object(s).
• Masks, tags and pools are listed only if they apply to all object(s).

This is a read-only permission probe. Passing pool_id or tag_ids computes the rights as if the object(s) had been moved or retagged, but no object is actually modified.

Differs from easydb 5: _available_masks and _available_tags are populated only when the session holds the read right on every probed object; easydb 5 documents these two lists as "only provided if 'write' is in _generated_rights".

Authorizations

BearerAuthAccessTokenQueryFylrAuthHeader

AuthorizationstringRequired

Access token in the Authorization header: Authorization: Bearer <token>.

Header parameters

x-fylr-authorizationstringOptional

The access token in form of Bearer <token>. You can also use authorization which does the same. authorization is looked at first.

authorizationstringOptional

The access token in form of Bearer <token>.

Body

application/json

objecttypestringRequired

The object type to check the update permissions for.

object_idsinteger[]Required

The object IDs to check permissions for.

pool_idintegerOptional

The ID of the pool to check the permissions for. This assumes that the object(s) will be moved to that pool.

tag_idsinteger[] · nullableOptional

List of tag IDs which are assumed for the updated object. If omitted, the check will use the current tags of the object(s). Setting null is the same as setting []. This assumes that the update will remove all tags from the object(s).

Responses

200

A list of masks, pool IDs, tags and _generated_rights compiled for all objects together. The lists contain only items which are available for all objects.

application/json

_available_poolsinteger[]Optional

List of pool IDs the object(s) can be in. The current pool of the object(s) is always included (when shared by all object(s)). A different destination pool is listed only if the user holds the unlink right in the current pool and the link right in that destination pool. system.root sees all pools. Only populated when the requesting session holds read on every object.

400

The permission check could not be performed. When present, the code field of the response identifies the specific reason; not every 400 carries a stable code (input-validation failures are returned as generic messages).

application/json

401

No authenticated user. The request must carry a valid access token.

Differs from easydb 5: a missing/invalid session is reported as 401 (UnauthorizedError); easydb 5 documents the unauthenticated case as a 400.

application/json

{
  "_available_masks": [
    {
      "_id": 11,
      "name": "nested__all_fields"
    },
    {
      "_id": 12,
      "name": "mask_with_splitters"
    },
    {
      "name": "_all_fields"
    }
  ],
  "_available_tags": [
    {
      "_id": 2
    },
    {
      "_id": 3
    },
    {
      "_id": 1
    }
  ],
  "_available_pools": [
    1,
    2,
    3,
    4,
    5
  ],
  "_generated_rights": {
    "read": {},
    "write": {},
    "delete": {},
    "acl": {},
    "change_owner": {},
    "unlink": {},
    "owner": {}
  }
}