Skip to main content

AccessGroupRulesDto

Every rule of an access group

Within a group, values of the same type combine as "any of" or "all of" (per the match field for that type; libraries are always "any of"), and different types combine with AND. Across groups, what each group allows is combined with OR. Denies from every group always win. Admins and maintainers are never restricted.

genreMatchRuleMatchrequired

How allowed genres combine

Possible values: [any, all]

genres object[]required

Rules on genres, matched by name

  • Array [
  • accessModeAccessModerequired

    Allow or deny

    Possible values: [allow, deny]

    namestringrequired

    Tag or genre name

    Example: Adult
  • ]
  • libraries object[]required

    Rules on libraries

  • Array [
  • accessModeAccessModerequired

    Allow or deny

    Possible values: [allow, deny]

    libraryIdstring<uuid>required

    Library ID

    namestringrequired

    Library name

    Example: Manga
  • ]
  • sharingTagMatchRuleMatchrequired

    How allowed sharing tags combine

    Possible values: [any, all]

    sharingTags object[]required

    Rules on sharing tags

  • Array [
  • accessModeAccessModerequired

    Allow or deny

    Possible values: [allow, deny]

    namestringrequired

    Sharing tag name

    Example: Kids
    sharingTagIdstring<uuid>required

    Sharing tag ID

  • ]
  • tagMatchRuleMatchrequired

    How allowed tags combine

    Possible values: [any, all]

    tags object[]required

    Rules on regular tags, matched by name

  • Array [
  • accessModeAccessModerequired

    Allow or deny

    Possible values: [allow, deny]

    namestringrequired

    Tag or genre name

    Example: Adult
  • ]
  • AccessGroupRulesDto
    {
    "genreMatch": "any",
    "genres": [
    {
    "accessMode": "allow",
    "name": "Adult"
    }
    ],
    "libraries": [
    {
    "accessMode": "allow",
    "libraryId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "name": "Manga"
    }
    ],
    "sharingTagMatch": "any",
    "sharingTags": [
    {
    "accessMode": "allow",
    "name": "Kids",
    "sharingTagId": "3fa85f64-5717-4562-b3fc-2c963f66afa6"
    }
    ],
    "tagMatch": "any",
    "tags": [
    {
    "accessMode": "allow",
    "name": "Adult"
    }
    ]
    }