Skip to main content

AccessGroupDetailDto

Access group detail (includes members, grants, and OIDC mappings)

createdAtstring<date-time>required

Creation timestamp

Example: 2024-01-01T00:00:00Z
descriptionstring | nullnullable

Optional description

Example: Users who can access manga content
grants object[]required

Tag grants for the group

  • Array [
  • accessModeAccessMode (string)required

    Access mode: allow or deny

    Possible values: [allow, deny]

    createdAtstring<date-time>required

    Grant creation timestamp

    Example: 2024-01-01T00:00:00Z
    sharingTagIdstring<uuid>required

    Sharing tag ID

    Example: 550e8400-e29b-41d4-a716-446655440000
    sharingTagNamestringrequired

    Sharing tag name

    Example: manga
  • ]
  • idstring<uuid>required

    Unique access group identifier

    Example: 550e8400-e29b-41d4-a716-446655440000
    members object[]required

    Members of the group

  • Array [
  • createdAtstring<date-time>required

    When the user was added to the group

    Example: 2024-01-01T00:00:00Z
    sourcestringrequired

    Membership source (manual or oidc)

    Example: manual
    userIdstring<uuid>required

    User ID

    Example: 550e8400-e29b-41d4-a716-446655440000
    usernamestringrequired

    Username

    Example: alice
  • ]
  • namestringrequired

    Display name of the access group

    Example: Manga Readers
    oidcMappings object[]required

    OIDC mappings for the group

  • Array [
  • createdAtstring<date-time>required

    Mapping creation timestamp

    Example: 2024-01-01T00:00:00Z
    idstring<uuid>required

    Mapping ID

    Example: 550e8400-e29b-41d4-a716-446655440000
    oidcGroupNamestringrequired

    OIDC group name from the IdP

    Example: library-staff
  • ]
  • updatedAtstring<date-time>required

    Last update timestamp

    Example: 2024-01-15T10:30:00Z
    AccessGroupDetailDto
    {
    "createdAt": "2024-01-01T00:00:00Z",
    "description": "Users who can access manga content",
    "grants": [
    {
    "accessMode": "allow",
    "createdAt": "2024-01-01T00:00:00Z",
    "sharingTagId": "550e8400-e29b-41d4-a716-446655440000",
    "sharingTagName": "manga"
    }
    ],
    "id": "550e8400-e29b-41d4-a716-446655440000",
    "members": [
    {
    "createdAt": "2024-01-01T00:00:00Z",
    "source": "manual",
    "userId": "550e8400-e29b-41d4-a716-446655440000",
    "username": "alice"
    }
    ],
    "name": "Manga Readers",
    "oidcMappings": [
    {
    "createdAt": "2024-01-01T00:00:00Z",
    "id": "550e8400-e29b-41d4-a716-446655440000",
    "oidcGroupName": "library-staff"
    }
    ],
    "updatedAt": "2024-01-15T10:30:00Z"
    }