definitions:
  api.apiCimdAccessUpdateDto:
    properties:
      enabled:
        type: boolean
      permissionIds:
        items:
          type: string
        type: array
    required:
    - permissionIds
    type: object
  api.apiClientAccessDto:
    properties:
      cimdGrantedAccess:
        type: boolean
      cimdGrantedPermissionIds:
        items:
          type: string
        type: array
      client:
        $ref: '#/definitions/api.apiClientDto'
      clientAccess:
        type: boolean
      clientPermissionIds:
        items:
          type: string
        type: array
      userDelegatedAccess:
        type: boolean
      userDelegatedPermissionIds:
        items:
          type: string
        type: array
    type: object
  api.apiClientDto:
    properties:
      clientType:
        type: string
      hasDarkLogo:
        type: boolean
      hasLogo:
        type: boolean
      id:
        type: string
      isPublic:
        type: boolean
      name:
        type: string
    type: object
  api.apiClientGrantDto:
    properties:
      clientAccess:
        type: boolean
      clientPermissionIds:
        items:
          type: string
        type: array
      userDelegatedAccess:
        type: boolean
      userDelegatedPermissionIds:
        items:
          type: string
        type: array
    type: object
  api.apiClientGrantUpdateDto:
    properties:
      clientAccess:
        type: boolean
      clientPermissionIds:
        items:
          type: string
        type: array
      userDelegatedAccess:
        type: boolean
      userDelegatedPermissionIds:
        items:
          type: string
        type: array
    required:
    - clientPermissionIds
    - userDelegatedPermissionIds
    type: object
  api.apiCreateDto:
    properties:
      name:
        maxLength: 50
        minLength: 1
        type: string
      resource:
        maxLength: 350
        type: string
    required:
    - name
    - resource
    type: object
  api.apiPermissionInputDto:
    properties:
      description:
        maxLength: 200
        type: string
      key:
        maxLength: 128
        minLength: 1
        type: string
      name:
        maxLength: 50
        minLength: 1
        type: string
    required:
    - key
    - name
    type: object
  api.apiPermissionResponseDto:
    properties:
      allowedForCimdClients:
        type: boolean
      description:
        type: string
      id:
        type: string
      key:
        type: string
      name:
        type: string
    type: object
  api.apiPermissionsUpdateDto:
    properties:
      permissions:
        items:
          $ref: '#/definitions/api.apiPermissionInputDto'
        type: array
    type: object
  api.apiResponseDto:
    properties:
      allowCimdClients:
        type: boolean
      createdAt:
        type: string
      id:
        type: string
      name:
        type: string
      permissions:
        items:
          $ref: '#/definitions/api.apiPermissionResponseDto'
        type: array
      resource:
        type: string
    type: object
  api.apiUpdateDto:
    properties:
      name:
        maxLength: 50
        minLength: 1
        type: string
    required:
    - name
    type: object
  api.clientApiGrantDto:
    properties:
      api:
        $ref: '#/definitions/api.apiResponseDto'
      cimdGrantedAccess:
        type: boolean
      cimdGrantedPermissionIds:
        items:
          type: string
        type: array
      clientAccess:
        type: boolean
      clientPermissionIds:
        items:
          type: string
        type: array
      userDelegatedAccess:
        type: boolean
      userDelegatedPermissionIds:
        items:
          type: string
        type: array
    type: object
  apikey.apiKeyCreateDto:
    properties:
      description:
        type: string
      expiresAt:
        type: string
      name:
        maxLength: 50
        minLength: 3
        type: string
    required:
    - expiresAt
    - name
    type: object
  apikey.apiKeyDto:
    properties:
      createdAt:
        type: string
      description:
        type: string
      expirationEmailSent:
        type: boolean
      expiresAt:
        type: string
      id:
        type: string
      lastUsedAt:
        type: string
      name:
        type: string
    type: object
  apikey.apiKeyResponseDto:
    properties:
      apiKey:
        $ref: '#/definitions/apikey.apiKeyDto'
      token:
        type: string
    type: object
  apperror.Code:
    enum:
    - internal_error
    - validation_failed
    - invalid_request_body
    - request_timeout
    - not_found
    - already_in_use
    - forbidden
    - invalid_token
    - rate_limited
    - file_too_large
    - invalid_image
    - invalid_webauthn_response
    - webauthn_authentication_failed
    - passkey_user_verification_required
    - synced_passkey_not_allowed
    - invalid_webauthn_session
    - user_not_found
    - user_disabled
    - api_key_not_found
    - invalid_api_key
    - device_login_expired
    - reauthentication_required
    - invalid_email_verification_token
    - email_verification_required
    - email_change_not_started
    - setup_not_available
    - setup_already_completed
    - token_invalid_or_expired
    - device_code_invalid
    - oidc_missing_authorization
    - oidc_invalid_callback_url
    - file_type_not_supported
    - not_signed_in
    - missing_session_id
    - reserved_claim
    - duplicate_claim
    - ldap_disabled
    - ldap_user_update
    - ldap_user_group_update
    - oidc_access_denied
    - oidc_client_id_not_matching
    - ui_config_disabled
    - one_time_access_disabled
    - device_login_denied
    - no_api_key_provided
    - api_key_not_expired
    - invalid_api_key_expiration
    - api_key_auth_not_allowed
    - oidc_device_code_expired
    - oidc_invalid_device_code
    - open_signup_disabled
    - client_id_already_exists
    - user_email_not_set
    - image_not_found
    - logo_download_failed
    - logo_type_not_supported
    - logo_too_large
    - logo_presets_disabled
    - logo_presets_unavailable
    - oidc_par_required
    type: string
    x-enum-varnames:
    - CodeInternal
    - CodeValidationFailed
    - CodeInvalidRequestBody
    - CodeRequestTimeout
    - CodeNotFound
    - CodeAlreadyInUse
    - CodeForbidden
    - CodeInvalidToken
    - CodeRateLimited
    - CodeFileTooLarge
    - CodeInvalidImage
    - CodeInvalidWebAuthnResponse
    - CodeWebAuthnAuthenticationFailed
    - CodePasskeyUserVerificationRequired
    - CodeSyncedPasskeyNotAllowed
    - CodeInvalidWebAuthnSession
    - CodeUserNotFound
    - CodeUserDisabled
    - CodeAPIKeyNotFound
    - CodeInvalidAPIKey
    - CodeDeviceLoginExpired
    - CodeReauthenticationRequired
    - CodeEmailVerificationTokenInvalid
    - CodeEmailVerificationRequired
    - CodeEmailChangeNotStarted
    - CodeSetupNotAvailable
    - CodeSetupAlreadyCompleted
    - CodeTokenInvalidOrExpired
    - CodeDeviceCodeInvalid
    - CodeOidcMissingAuthorization
    - CodeOidcInvalidCallbackURL
    - CodeFileTypeNotSupported
    - CodeNotSignedIn
    - CodeMissingSessionID
    - CodeReservedClaim
    - CodeDuplicateClaim
    - CodeLdapDisabled
    - CodeLdapUserUpdate
    - CodeLdapUserGroupUpdate
    - CodeOidcAccessDenied
    - CodeOidcClientIDNotMatching
    - CodeUIConfigDisabled
    - CodeOneTimeAccessDisabled
    - CodeDeviceLoginDenied
    - CodeNoAPIKeyProvided
    - CodeAPIKeyNotExpired
    - CodeInvalidAPIKeyExpiration
    - CodeAPIKeyAuthNotAllowed
    - CodeOidcDeviceCodeExpired
    - CodeOidcInvalidDeviceCode
    - CodeOpenSignupDisabled
    - CodeClientIDAlreadyExists
    - CodeUserEmailNotSet
    - CodeImageNotFound
    - CodeLogoDownloadFailed
    - CodeLogoTypeNotSupported
    - CodeLogoTooLarge
    - CodeLogoPresetsDisabled
    - CodeLogoPresetsUnavailable
    - CodeOidcPARRequired
  auditlogs.auditLogDto:
    properties:
      actorUsername:
        type: string
      city:
        type: string
      country:
        type: string
      createdAt:
        type: string
      data:
        additionalProperties:
          type: string
        type: object
      device:
        type: string
      event:
        type: string
      id:
        type: string
      ipAddress:
        type: string
      userID:
        type: string
      username:
        type: string
    type: object
  devicelogin.decisionDto:
    properties:
      code:
        type: string
      decision:
        enum:
        - approve
        - deny
        type: string
    required:
    - code
    - decision
    type: object
  devicelogin.requestCreateDto:
    properties:
      expiresAt:
        type: string
      id:
        type: string
      interval:
        type: integer
      userCode:
        type: string
      verificationUri:
        type: string
      verificationUriComplete:
        type: string
    type: object
  devicelogin.verificationDto:
    properties:
      code:
        type: string
    required:
    - code
    type: object
  devicelogin.verificationInfoDto:
    properties:
      city:
        type: string
      country:
        type: string
      device:
        type: string
      expiresAt:
        type: string
      ipAddress:
        type: string
      userCode:
        type: string
    type: object
  dto.AccessibleOidcClientDto:
    properties:
      clientType:
        type: string
      description:
        type: string
      hasDarkLogo:
        type: boolean
      hasLogo:
        type: boolean
      id:
        type: string
      lastUsedAt:
        type: string
      launchURL:
        type: string
      name:
        type: string
      requiresReauthentication:
        type: boolean
    type: object
  dto.AppConfigUpdateDto:
    properties:
      accentColor:
        type: string
      allowOwnAccountEdit:
        type: string
      allowUserSignups:
        enum:
        - disabled
        - withToken
        - open
        type: string
      appName:
        maxLength: 30
        minLength: 1
        type: string
      autoCreateOidcClientSecret:
        type: string
      cimdUrlAllowlist:
        type: string
      disableAnimations:
        type: string
      emailApiKeyExpirationEnabled:
        type: string
      emailLoginNotificationMode:
        enum:
        - disabled
        - always
        - ipAndUserAgent
        - browserRecognition
        type: string
      emailOneTimeAccessAsAdminEnabled:
        type: string
      emailOneTimeAccessAsUnauthenticatedEnabled:
        type: string
      emailVerification:
        enum:
        - disabled
        - optional
        - required
        type: string
      emailsVerified:
        type: string
      homePageUrl:
        type: string
      ldapAdminGroupName:
        type: string
      ldapAttributeGroupMember:
        type: string
      ldapAttributeGroupName:
        type: string
      ldapAttributeGroupUniqueIdentifier:
        type: string
      ldapAttributeUserDisplayName:
        type: string
      ldapAttributeUserEmail:
        type: string
      ldapAttributeUserFirstName:
        type: string
      ldapAttributeUserLastName:
        type: string
      ldapAttributeUserProfilePicture:
        type: string
      ldapAttributeUserUniqueIdentifier:
        type: string
      ldapAttributeUserUsername:
        type: string
      ldapBase:
        type: string
      ldapBindDn:
        type: string
      ldapBindPassword:
        type: string
      ldapEnabled:
        type: string
      ldapSkipCertVerify:
        type: string
      ldapSoftDeleteUsers:
        type: string
      ldapUrl:
        type: string
      ldapUserGroupSearchFilter:
        type: string
      ldapUserSearchFilter:
        type: string
      requireUserEmail:
        type: string
      sessionDuration:
        type: string
      signupDefaultCustomClaims:
        type: string
      signupDefaultUserGroupIDs:
        type: string
      smtpFrom:
        type: string
      smtpHost:
        type: string
      smtpPassword:
        type: string
      smtpPort:
        type: string
      smtpSkipCertVerify:
        type: string
      smtpTls:
        enum:
        - none
        - starttls
        - tls
        type: string
      smtpUser:
        type: string
      webauthnAllowSyncedPasskeys:
        type: string
      webauthnAuthenticatorAttachment:
        enum:
        - any
        - platform
        - cross-platform
        type: string
      webauthnUserVerification:
        enum:
        - required
        - preferred
        type: string
    required:
    - allowOwnAccountEdit
    - allowUserSignups
    - appName
    - autoCreateOidcClientSecret
    - disableAnimations
    - emailApiKeyExpirationEnabled
    - emailLoginNotificationMode
    - emailOneTimeAccessAsAdminEnabled
    - emailOneTimeAccessAsUnauthenticatedEnabled
    - emailVerification
    - emailsVerified
    - homePageUrl
    - ldapEnabled
    - ldapSkipCertVerify
    - ldapSoftDeleteUsers
    - requireUserEmail
    - sessionDuration
    - smtpSkipCertVerify
    - smtpTls
    - webauthnAllowSyncedPasskeys
    - webauthnAuthenticatorAttachment
    - webauthnUserVerification
    type: object
  dto.AppConfigVariableDto:
    properties:
      isPublic:
        type: boolean
      key:
        type: string
      type:
        type: string
      value:
        type: string
    type: object
  dto.AuthorizedOidcClientDto:
    properties:
      client:
        $ref: '#/definitions/dto.OidcClientMetaDataDto'
      lastUsedAt:
        type: string
      scope:
        type: string
    type: object
  dto.CustomClaimCreateDto:
    properties:
      key:
        type: string
      value:
        type: string
    required:
    - key
    - value
    type: object
  dto.CustomClaimDto:
    properties:
      key:
        type: string
      value:
        type: string
    type: object
  dto.EmailVerificationDto:
    properties:
      token:
        type: string
    required:
    - token
    type: object
  dto.ErrorDto:
    properties:
      code:
        $ref: '#/definitions/apperror.Code'
      details:
        additionalProperties: {}
        type: object
      error:
        type: string
      request_id:
        type: string
    type: object
  dto.OidcClientCreateDto:
    properties:
      accessTokenDurationMinutes:
        type: integer
      backchannelLogoutURL:
        type: string
      callbackURLs:
        items:
          type: string
        type: array
      credentials:
        $ref: '#/definitions/dto.OidcClientCredentialsDto'
      darkLogoUrl:
        type: string
      description:
        maxLength: 150
        type: string
      hasDarkLogo:
        type: boolean
      hasLogo:
        type: boolean
      id:
        maxLength: 128
        minLength: 2
        type: string
      isGroupRestricted:
        type: boolean
      isPublic:
        type: boolean
      launchURL:
        type: string
      logoUrl:
        type: string
      logoutCallbackURLs:
        items:
          type: string
        type: array
      name:
        maxLength: 50
        type: string
      pkceEnabled:
        type: boolean
      refreshTokenDurationMinutes:
        type: integer
      requiresPushedAuthorizationRequests:
        type: boolean
      requiresReauthentication:
        type: boolean
      skipConsent:
        type: boolean
    required:
    - name
    type: object
  dto.OidcClientCreatedDto:
    properties:
      accessTokenDurationMinutes:
        type: integer
      allowedUserGroups:
        items:
          $ref: '#/definitions/dto.UserGroupMinimalDto'
        type: array
      backchannelLogoutURL:
        type: string
      callbackURLs:
        items:
          type: string
        type: array
      clientType:
        type: string
      createdSecret:
        $ref: '#/definitions/dto.OidcClientSecretCreatedDto'
      credentials:
        $ref: '#/definitions/dto.OidcClientCredentialsDto'
      description:
        type: string
      hasDarkLogo:
        type: boolean
      hasLogo:
        type: boolean
      id:
        type: string
      isGroupRestricted:
        type: boolean
      isPublic:
        type: boolean
      launchURL:
        type: string
      logoutCallbackURLs:
        items:
          type: string
        type: array
      name:
        type: string
      pkceEnabled:
        type: boolean
      pkceSupported:
        type: boolean
      refreshTokenDurationMinutes:
        type: integer
      requiresPushedAuthorizationRequests:
        type: boolean
      requiresReauthentication:
        type: boolean
      skipConsent:
        type: boolean
    type: object
  dto.OidcClientCredentialsDto:
    properties:
      federatedIdentities:
        items:
          $ref: '#/definitions/dto.OidcClientFederatedIdentityDto'
        type: array
      secrets:
        description: 'Secrets is read-only: secrets are managed through the dedicated
          client secret endpoints and any value sent by a client is ignored'
        items:
          $ref: '#/definitions/dto.OidcClientSecretDto'
        type: array
    type: object
  dto.OidcClientDto:
    properties:
      accessTokenDurationMinutes:
        type: integer
      backchannelLogoutURL:
        type: string
      callbackURLs:
        items:
          type: string
        type: array
      clientType:
        type: string
      credentials:
        $ref: '#/definitions/dto.OidcClientCredentialsDto'
      description:
        type: string
      hasDarkLogo:
        type: boolean
      hasLogo:
        type: boolean
      id:
        type: string
      isGroupRestricted:
        type: boolean
      isPublic:
        type: boolean
      launchURL:
        type: string
      logoutCallbackURLs:
        items:
          type: string
        type: array
      name:
        type: string
      pkceEnabled:
        type: boolean
      pkceSupported:
        type: boolean
      refreshTokenDurationMinutes:
        type: integer
      requiresPushedAuthorizationRequests:
        type: boolean
      requiresReauthentication:
        type: boolean
      skipConsent:
        type: boolean
    type: object
  dto.OidcClientFederatedIdentityDto:
    properties:
      audience:
        type: string
      issuer:
        type: string
      jwks:
        type: string
      publicKeys:
        items:
          type: object
        type: array
      replayProtection:
        type: boolean
      subject:
        type: string
    type: object
  dto.OidcClientMetaDataDto:
    properties:
      clientType:
        type: string
      description:
        type: string
      hasDarkLogo:
        type: boolean
      hasLogo:
        type: boolean
      id:
        type: string
      launchURL:
        type: string
      name:
        type: string
      requiresReauthentication:
        type: boolean
    type: object
  dto.OidcClientPreviewDto:
    properties:
      accessToken:
        additionalProperties: {}
        type: object
      idToken:
        additionalProperties: {}
        type: object
      userInfo:
        additionalProperties: {}
        type: object
    type: object
  dto.OidcClientSecretCreateDto:
    properties:
      expiresAt:
        description: ExpiresAt makes the secret unusable after the given time (if
          nil, secrets don't expire)
        type: string
      secret:
        description: Secret allows callers to supply their own value instead of having
          Pocket ID generate one
        minLength: 16
        type: string
    type: object
  dto.OidcClientSecretCreatedDto:
    properties:
      createdAt:
        type: string
      expiresAt:
        type: string
      id:
        type: string
      isActive:
        type: boolean
      prefix:
        description: Prefix holds the first few characters of the secret in clear
          text, and is empty for secrets migrated from the single-secret column
        type: string
      secret:
        type: string
    type: object
  dto.OidcClientSecretDto:
    properties:
      createdAt:
        type: string
      expiresAt:
        type: string
      id:
        type: string
      isActive:
        type: boolean
      prefix:
        description: Prefix holds the first few characters of the secret in clear
          text, and is empty for secrets migrated from the single-secret column
        type: string
    type: object
  dto.OidcClientUpdateDto:
    properties:
      accessTokenDurationMinutes:
        type: integer
      backchannelLogoutURL:
        type: string
      callbackURLs:
        items:
          type: string
        type: array
      credentials:
        $ref: '#/definitions/dto.OidcClientCredentialsDto'
      darkLogoUrl:
        type: string
      description:
        maxLength: 150
        type: string
      hasDarkLogo:
        type: boolean
      hasLogo:
        type: boolean
      isGroupRestricted:
        type: boolean
      isPublic:
        type: boolean
      launchURL:
        type: string
      logoUrl:
        type: string
      logoutCallbackURLs:
        items:
          type: string
        type: array
      name:
        maxLength: 50
        type: string
      pkceEnabled:
        type: boolean
      refreshTokenDurationMinutes:
        type: integer
      requiresPushedAuthorizationRequests:
        type: boolean
      requiresReauthentication:
        type: boolean
      skipConsent:
        type: boolean
    required:
    - name
    type: object
  dto.OidcClientWithAllowedGroupsDto:
    properties:
      accessTokenDurationMinutes:
        type: integer
      allowedUserGroups:
        items:
          $ref: '#/definitions/dto.UserGroupMinimalDto'
        type: array
      backchannelLogoutURL:
        type: string
      callbackURLs:
        items:
          type: string
        type: array
      clientType:
        type: string
      credentials:
        $ref: '#/definitions/dto.OidcClientCredentialsDto'
      description:
        type: string
      hasDarkLogo:
        type: boolean
      hasLogo:
        type: boolean
      id:
        type: string
      isGroupRestricted:
        type: boolean
      isPublic:
        type: boolean
      launchURL:
        type: string
      logoutCallbackURLs:
        items:
          type: string
        type: array
      name:
        type: string
      pkceEnabled:
        type: boolean
      pkceSupported:
        type: boolean
      refreshTokenDurationMinutes:
        type: integer
      requiresPushedAuthorizationRequests:
        type: boolean
      requiresReauthentication:
        type: boolean
      skipConsent:
        type: boolean
    type: object
  dto.OidcClientWithAllowedUserGroupsDto:
    properties:
      accessTokenDurationMinutes:
        type: integer
      allowedUserGroups:
        items:
          $ref: '#/definitions/dto.UserGroupMinimalDto'
        type: array
      backchannelLogoutURL:
        type: string
      callbackURLs:
        items:
          type: string
        type: array
      clientType:
        type: string
      credentials:
        $ref: '#/definitions/dto.OidcClientCredentialsDto'
      description:
        type: string
      hasDarkLogo:
        type: boolean
      hasLogo:
        type: boolean
      id:
        type: string
      isGroupRestricted:
        type: boolean
      isPublic:
        type: boolean
      launchURL:
        type: string
      logoutCallbackURLs:
        items:
          type: string
        type: array
      name:
        type: string
      pkceEnabled:
        type: boolean
      pkceSupported:
        type: boolean
      refreshTokenDurationMinutes:
        type: integer
      requiresPushedAuthorizationRequests:
        type: boolean
      requiresReauthentication:
        type: boolean
      skipConsent:
        type: boolean
    type: object
  dto.OidcUpdateAllowedUserGroupsDto:
    properties:
      userGroupIds:
        items:
          type: string
        type: array
    required:
    - userGroupIds
    type: object
  dto.Pagination:
    properties:
      currentPage:
        type: integer
      itemsPerPage:
        type: integer
      totalItems:
        type: integer
      totalPages:
        type: integer
    type: object
  dto.PublicAppConfigVariableDto:
    properties:
      key:
        type: string
      type:
        type: string
      value:
        type: string
    type: object
  dto.UserCreateDto:
    properties:
      disabled:
        type: boolean
      displayName:
        maxLength: 100
        type: string
      email:
        type: string
      emailVerified:
        type: boolean
      firstName:
        maxLength: 50
        type: string
      id:
        type: string
      isAdmin:
        type: boolean
      lastName:
        maxLength: 50
        type: string
      locale:
        type: string
      userGroupIds:
        items:
          type: string
        type: array
      username:
        maxLength: 50
        minLength: 1
        type: string
    required:
    - username
    type: object
  dto.UserDto:
    properties:
      customClaims:
        items:
          $ref: '#/definitions/dto.CustomClaimDto'
        type: array
      disabled:
        type: boolean
      displayName:
        type: string
      email:
        type: string
      emailVerificationDeadline:
        type: string
      emailVerified:
        type: boolean
      firstName:
        type: string
      id:
        type: string
      isAdmin:
        type: boolean
      lastName:
        type: string
      ldapId:
        type: string
      locale:
        type: string
      userGroups:
        items:
          $ref: '#/definitions/dto.UserGroupMinimalDto'
        type: array
      username:
        type: string
    type: object
  dto.UserGroupCreateDto:
    properties:
      friendlyName:
        maxLength: 50
        minLength: 2
        type: string
      name:
        maxLength: 255
        minLength: 2
        type: string
    required:
    - friendlyName
    - name
    type: object
  dto.UserGroupDto:
    properties:
      allowedOidcClients:
        items:
          $ref: '#/definitions/dto.OidcClientMetaDataDto'
        type: array
      createdAt:
        type: string
      customClaims:
        items:
          $ref: '#/definitions/dto.CustomClaimDto'
        type: array
      friendlyName:
        type: string
      id:
        type: string
      ldapId:
        type: string
      name:
        type: string
      users:
        items:
          $ref: '#/definitions/dto.UserDto'
        type: array
    type: object
  dto.UserGroupMinimalDto:
    properties:
      createdAt:
        type: string
      customClaims:
        items:
          $ref: '#/definitions/dto.CustomClaimDto'
        type: array
      friendlyName:
        type: string
      id:
        type: string
      ldapId:
        type: string
      name:
        type: string
      userCount:
        type: integer
    type: object
  dto.UserGroupUpdateAllowedOidcClientsDto:
    properties:
      oidcClientIds:
        items:
          type: string
        type: array
    required:
    - oidcClientIds
    type: object
  dto.UserGroupUpdateUsersDto:
    properties:
      userIds:
        items:
          type: string
        type: array
    required:
    - userIds
    type: object
  dto.UserUpdateUserGroupDto:
    properties:
      userGroupIds:
        items:
          type: string
        type: array
    required:
    - userGroupIds
    type: object
  dto.WebauthnCredentialDto:
    properties:
      aaguid:
        type: string
      attestationType:
        type: string
      backupEligible:
        type: boolean
      backupState:
        type: boolean
      createdAt:
        type: string
      credentialID:
        type: string
      hasIcon:
        type: boolean
      id:
        type: string
      name:
        type: string
      transport:
        items:
          type: string
        type: array
    type: object
  emailverification.emailChangeDto:
    properties:
      email:
        type: string
      expiresAt:
        type: string
    type: object
  github_com_pocket-id_pocket-id_backend_internal_dto.Paginated-api_apiClientAccessDto:
    properties:
      data:
        items:
          $ref: '#/definitions/api.apiClientAccessDto'
        type: array
      pagination:
        $ref: '#/definitions/dto.Pagination'
    type: object
  github_com_pocket-id_pocket-id_backend_internal_dto.Paginated-api_apiClientDto:
    properties:
      data:
        items:
          $ref: '#/definitions/api.apiClientDto'
        type: array
      pagination:
        $ref: '#/definitions/dto.Pagination'
    type: object
  github_com_pocket-id_pocket-id_backend_internal_dto.Paginated-api_apiResponseDto:
    properties:
      data:
        items:
          $ref: '#/definitions/api.apiResponseDto'
        type: array
      pagination:
        $ref: '#/definitions/dto.Pagination'
    type: object
  github_com_pocket-id_pocket-id_backend_internal_dto.Paginated-apikey_apiKeyDto:
    properties:
      data:
        items:
          $ref: '#/definitions/apikey.apiKeyDto'
        type: array
      pagination:
        $ref: '#/definitions/dto.Pagination'
    type: object
  github_com_pocket-id_pocket-id_backend_internal_dto.Paginated-auditlogs_auditLogDto:
    properties:
      data:
        items:
          $ref: '#/definitions/auditlogs.auditLogDto'
        type: array
      pagination:
        $ref: '#/definitions/dto.Pagination'
    type: object
  github_com_pocket-id_pocket-id_backend_internal_dto.Paginated-dto_AccessibleOidcClientDto:
    properties:
      data:
        items:
          $ref: '#/definitions/dto.AccessibleOidcClientDto'
        type: array
      pagination:
        $ref: '#/definitions/dto.Pagination'
    type: object
  github_com_pocket-id_pocket-id_backend_internal_dto.Paginated-dto_AuthorizedOidcClientDto:
    properties:
      data:
        items:
          $ref: '#/definitions/dto.AuthorizedOidcClientDto'
        type: array
      pagination:
        $ref: '#/definitions/dto.Pagination'
    type: object
  github_com_pocket-id_pocket-id_backend_internal_dto.Paginated-dto_OidcClientWithAllowedGroupsDto:
    properties:
      data:
        items:
          $ref: '#/definitions/dto.OidcClientWithAllowedGroupsDto'
        type: array
      pagination:
        $ref: '#/definitions/dto.Pagination'
    type: object
  github_com_pocket-id_pocket-id_backend_internal_dto.Paginated-dto_UserDto:
    properties:
      data:
        items:
          $ref: '#/definitions/dto.UserDto'
        type: array
      pagination:
        $ref: '#/definitions/dto.Pagination'
    type: object
  github_com_pocket-id_pocket-id_backend_internal_dto.Paginated-dto_UserGroupMinimalDto:
    properties:
      data:
        items:
          $ref: '#/definitions/dto.UserGroupMinimalDto'
        type: array
      pagination:
        $ref: '#/definitions/dto.Pagination'
    type: object
  github_com_pocket-id_pocket-id_backend_internal_dto.Paginated-usersignup_signupTokenDto:
    properties:
      data:
        items:
          $ref: '#/definitions/usersignup.signupTokenDto'
        type: array
      pagination:
        $ref: '#/definitions/dto.Pagination'
    type: object
  logopreset.logoPresetDto:
    properties:
      darkLogoUrl:
        type: string
      logoUrl:
        type: string
      name:
        type: string
      reference:
        type: string
    type: object
  onetimeaccess.emailAsAdminDto:
    properties:
      ttl:
        $ref: '#/definitions/utils.JSONDuration'
    type: object
  onetimeaccess.emailAsUnauthenticatedUserDto:
    properties:
      email:
        type: string
      redirectPath:
        type: string
    required:
    - email
    type: object
  onetimeaccess.tokenCreateDto:
    type: object
  scimsync.ScimServiceProviderCreateDTO:
    properties:
      endpoint:
        type: string
      oidcClientId:
        type: string
      token:
        type: string
    required:
    - endpoint
    - oidcClientId
    type: object
  scimsync.ScimServiceProviderDTO:
    properties:
      createdAt:
        type: string
      endpoint:
        type: string
      id:
        type: string
      lastSyncedAt:
        type: string
      oidcClient:
        $ref: '#/definitions/dto.OidcClientMetaDataDto'
      token:
        type: string
    type: object
  usersignup.signUpDto:
    properties:
      email:
        type: string
      firstName:
        maxLength: 50
        type: string
      lastName:
        maxLength: 50
        type: string
      token:
        type: string
      username:
        maxLength: 50
        minLength: 1
        type: string
    required:
    - username
    type: object
  usersignup.signupTokenCreateDto:
    properties:
      ttl:
        $ref: '#/definitions/utils.JSONDuration'
      usageLimit:
        maximum: 100
        minimum: 1
        type: integer
      userGroupIds:
        items:
          type: string
        type: array
    required:
    - ttl
    - usageLimit
    type: object
  usersignup.signupTokenDto:
    properties:
      createdAt:
        type: string
      expiresAt:
        type: string
      id:
        type: string
      token:
        type: string
      usageCount:
        type: integer
      usageLimit:
        type: integer
      userGroups:
        items:
          $ref: '#/definitions/dto.UserGroupMinimalDto'
        type: array
    type: object
  utils.JSONDuration:
    type: object
info:
  contact: {}
  description: |
    Pocket ID API Reference
  title: Pocket ID API
  version: "1.0"
paths:
  /.well-known/jwks.json:
    get:
      description: Returns the JSON Web Key Set used for token verification
      produces:
      - application/json
      responses:
        "200":
          description: '{ \"keys\": []interface{} }'
          schema:
            type: object
        default:
          description: Error
          schema:
            $ref: '#/definitions/dto.ErrorDto'
      summary: Get JSON Web Key Set (JWKS)
      tags:
      - Well Known
  /.well-known/oauth-authorization-server:
    get:
      description: Returns the RFC 8414 OAuth 2.0 authorization server metadata document
        with endpoints and capabilities
      responses:
        "200":
          description: OAuth 2.0 authorization server metadata
          schema:
            type: object
        default:
          description: Error
          schema:
            $ref: '#/definitions/dto.ErrorDto'
      summary: Get OAuth 2.0 authorization server metadata
      tags:
      - Well Known
  /.well-known/openid-configuration:
    get:
      description: Returns the OpenID Connect discovery document with endpoints and
        capabilities
      responses:
        "200":
          description: OpenID Connect configuration
          schema:
            type: object
        default:
          description: Error
          schema:
            $ref: '#/definitions/dto.ErrorDto'
      summary: Get OpenID Connect discovery configuration
      tags:
      - Well Known
  /api/api-access/{clientId}/apis:
    get:
      description: Get every API the OIDC client may request tokens for, with its
        access and permissions split into user-delegated and client (machine-to-machine)
        access
      parameters:
      - description: OIDC Client ID
        in: path
        name: clientId
        required: true
        type: string
      produces:
      - application/json
      responses:
        "200":
          description: OK
          schema:
            items:
              $ref: '#/definitions/api.clientApiGrantDto'
            type: array
      summary: List APIs a client may access
      tags:
      - APIs
  /api/api-access/{clientId}/assignable-apis:
    get:
      description: Get a paginated list of APIs the OIDC client cannot already reach
      parameters:
      - description: OIDC Client ID
        in: path
        name: clientId
        required: true
        type: string
      - description: Search term to filter APIs by name or resource
        in: query
        name: search
        type: string
      - default: 1
        description: Page number for pagination
        in: query
        name: pagination[page]
        type: integer
      - default: 20
        description: Number of items per page
        in: query
        name: pagination[limit]
        type: integer
      - description: Column to sort by
        in: query
        name: sort[column]
        type: string
      - default: '"asc"'
        description: Sort direction (asc or desc)
        in: query
        name: sort[direction]
        type: string
      produces:
      - application/json
      responses:
        "200":
          description: OK
          schema:
            $ref: '#/definitions/github_com_pocket-id_pocket-id_backend_internal_dto.Paginated-api_apiResponseDto'
      summary: List APIs a client can still be granted access to
      tags:
      - APIs
  /api/api-keys:
    get:
      description: Get a paginated list of API keys belonging to the current user
      parameters:
      - default: 1
        description: Page number for pagination
        in: query
        name: pagination[page]
        type: integer
      - default: 20
        description: Number of items per page
        in: query
        name: pagination[limit]
        type: integer
      - description: Column to sort by
        in: query
        name: sort[column]
        type: string
      - default: '"asc"'
        description: Sort direction (asc or desc)
        in: query
        name: sort[direction]
        type: string
      responses:
        "200":
          description: OK
          schema:
            $ref: '#/definitions/github_com_pocket-id_pocket-id_backend_internal_dto.Paginated-apikey_apiKeyDto'
      summary: List API keys
      tags:
      - API Keys
    post:
      description: Create a new API key for the current user
      parameters:
      - description: API key information
        in: body
        name: api_key
        required: true
        schema:
          $ref: '#/definitions/apikey.apiKeyCreateDto'
      responses:
        "201":
          description: Created API key with token
          schema:
            $ref: '#/definitions/apikey.apiKeyResponseDto'
      summary: Create API key
      tags:
      - API Keys
  /api/api-keys/{id}:
    delete:
      description: Revoke (delete) an existing API key by ID
      parameters:
      - description: API Key ID
        in: path
        name: id
        required: true
        type: string
      responses:
        "204":
          description: No Content
      summary: Revoke API key
      tags:
      - API Keys
  /api/api-keys/{id}/renew:
    post:
      description: Renew an existing API key by ID
      parameters:
      - description: API Key ID
        in: path
        name: id
        required: true
        type: string
      responses:
        "200":
          description: Renewed API key with new token
          schema:
            $ref: '#/definitions/apikey.apiKeyResponseDto'
      summary: Renew API key
      tags:
      - API Keys
  /api/apis:
    get:
      description: Get a paginated list of APIs with optional search and sorting
      parameters:
      - description: Search term to filter APIs by name or resource
        in: query
        name: search
        type: string
      - default: 1
        description: Page number for pagination
        in: query
        name: pagination[page]
        type: integer
      - default: 20
        description: Number of items per page
        in: query
        name: pagination[limit]
        type: integer
      - description: Column to sort by
        in: query
        name: sort[column]
        type: string
      - default: '"asc"'
        description: Sort direction (asc or desc)
        in: query
        name: sort[direction]
        type: string
      produces:
      - application/json
      responses:
        "200":
          description: OK
          schema:
            $ref: '#/definitions/github_com_pocket-id_pocket-id_backend_internal_dto.Paginated-api_apiResponseDto'
      summary: List APIs
      tags:
      - APIs
    post:
      consumes:
      - application/json
      description: Create a new API resource server
      parameters:
      - description: API information
        in: body
        name: api
        required: true
        schema:
          $ref: '#/definitions/api.apiCreateDto'
      produces:
      - application/json
      responses:
        "201":
          description: Created API
          schema:
            $ref: '#/definitions/api.apiResponseDto'
      summary: Create API
      tags:
      - APIs
  /api/apis/{id}:
    delete:
      description: Delete an API by ID
      parameters:
      - description: API ID
        in: path
        name: id
        required: true
        type: string
      responses:
        "204":
          description: No Content
      summary: Delete API
      tags:
      - APIs
    get:
      description: Retrieve a single API including its permissions
      parameters:
      - description: API ID
        in: path
        name: id
        required: true
        type: string
      produces:
      - application/json
      responses:
        "200":
          description: OK
          schema:
            $ref: '#/definitions/api.apiResponseDto'
      summary: Get API by ID
      tags:
      - APIs
    put:
      consumes:
      - application/json
      description: Update an existing API by ID
      parameters:
      - description: API ID
        in: path
        name: id
        required: true
        type: string
      - description: API information
        in: body
        name: api
        required: true
        schema:
          $ref: '#/definitions/api.apiUpdateDto'
      produces:
      - application/json
      responses:
        "200":
          description: Updated API
          schema:
            $ref: '#/definitions/api.apiResponseDto'
      summary: Update API
      tags:
      - APIs
  /api/apis/{id}/assignable-clients:
    get:
      description: Get a paginated list of OIDC clients that have no grant on the
        API yet
      parameters:
      - description: API ID
        in: path
        name: id
        required: true
        type: string
      - description: Search term to filter clients by name
        in: query
        name: search
        type: string
      - default: 1
        description: Page number for pagination
        in: query
        name: pagination[page]
        type: integer
      - default: 20
        description: Number of items per page
        in: query
        name: pagination[limit]
        type: integer
      - description: Column to sort by
        in: query
        name: sort[column]
        type: string
      - default: '"asc"'
        description: Sort direction (asc or desc)
        in: query
        name: sort[direction]
        type: string
      produces:
      - application/json
      responses:
        "200":
          description: OK
          schema:
            $ref: '#/definitions/github_com_pocket-id_pocket-id_backend_internal_dto.Paginated-api_apiClientDto'
      summary: List clients that can still be granted access to an API
      tags:
      - APIs
  /api/apis/{id}/cimd-access:
    put:
      consumes:
      - application/json
      description: Replace which permissions of an API every client registered through
        a Client ID Metadata Document may request
      parameters:
      - description: API ID
        in: path
        name: id
        required: true
        type: string
      - description: Metadata document client access
        in: body
        name: access
        required: true
        schema:
          $ref: '#/definitions/api.apiCimdAccessUpdateDto'
      produces:
      - application/json
      responses:
        "200":
          description: Updated API
          schema:
            $ref: '#/definitions/api.apiResponseDto'
      summary: Update metadata document client access
      tags:
      - APIs
  /api/apis/{id}/clients:
    get:
      description: Get a paginated list of OIDC clients that may reach the API, with
        their permissions split into user-delegated and client (machine-to-machine)
        access
      parameters:
      - description: API ID
        in: path
        name: id
        required: true
        type: string
      - description: Search term to filter clients by name
        in: query
        name: search
        type: string
      - default: 1
        description: Page number for pagination
        in: query
        name: pagination[page]
        type: integer
      - default: 20
        description: Number of items per page
        in: query
        name: pagination[limit]
        type: integer
      - description: Column to sort by
        in: query
        name: sort[column]
        type: string
      - default: '"asc"'
        description: Sort direction (asc or desc)
        in: query
        name: sort[direction]
        type: string
      produces:
      - application/json
      responses:
        "200":
          description: OK
          schema:
            $ref: '#/definitions/github_com_pocket-id_pocket-id_backend_internal_dto.Paginated-api_apiClientAccessDto'
      summary: List clients with access to an API
      tags:
      - APIs
  /api/apis/{id}/clients/{clientId}:
    delete:
      description: Remove every permission of this API a single OIDC client was allowed
        to request
      parameters:
      - description: API ID
        in: path
        name: id
        required: true
        type: string
      - description: OIDC Client ID
        in: path
        name: clientId
        required: true
        type: string
      responses:
        "204":
          description: No Content
      summary: Revoke a client's access to an API
      tags:
      - APIs
    put:
      consumes:
      - application/json
      description: Replace the permissions of this API a single OIDC client may request,
        leaving its grants on other APIs untouched
      parameters:
      - description: API ID
        in: path
        name: id
        required: true
        type: string
      - description: OIDC Client ID
        in: path
        name: clientId
        required: true
        type: string
      - description: Access and allowed permission IDs per subject type
        in: body
        name: access
        required: true
        schema:
          $ref: '#/definitions/api.apiClientGrantUpdateDto'
      produces:
      - application/json
      responses:
        "200":
          description: OK
          schema:
            $ref: '#/definitions/api.apiClientGrantDto'
      summary: Update a client's access to an API
      tags:
      - APIs
  /api/apis/{id}/permissions:
    put:
      consumes:
      - application/json
      description: Replace the full set of permissions for an API
      parameters:
      - description: API ID
        in: path
        name: id
        required: true
        type: string
      - description: Permissions to set
        in: body
        name: permissions
        required: true
        schema:
          $ref: '#/definitions/api.apiPermissionsUpdateDto'
      produces:
      - application/json
      responses:
        "200":
          description: Updated API
          schema:
            $ref: '#/definitions/api.apiResponseDto'
      summary: Update API permissions
      tags:
      - APIs
  /api/application-configuration:
    get:
      consumes:
      - application/json
      description: Get all public application configurations
      produces:
      - application/json
      responses:
        "200":
          description: OK
          schema:
            items:
              $ref: '#/definitions/dto.PublicAppConfigVariableDto'
            type: array
        default:
          description: Error
          schema:
            $ref: '#/definitions/dto.ErrorDto'
      summary: List public application configurations
      tags:
      - Application Configuration
    put:
      consumes:
      - application/json
      description: Update application configuration settings
      parameters:
      - description: Application Configuration
        in: body
        name: body
        required: true
        schema:
          $ref: '#/definitions/dto.AppConfigUpdateDto'
      produces:
      - application/json
      responses:
        "200":
          description: OK
          schema:
            items:
              $ref: '#/definitions/dto.AppConfigVariableDto'
            type: array
        default:
          description: Error
          schema:
            $ref: '#/definitions/dto.ErrorDto'
      summary: Update application configurations
      tags:
      - Application Configuration
  /api/application-configuration/all:
    get:
      consumes:
      - application/json
      description: Get all application configurations including private ones
      produces:
      - application/json
      responses:
        "200":
          description: OK
          schema:
            items:
              $ref: '#/definitions/dto.AppConfigVariableDto'
            type: array
        default:
          description: Error
          schema:
            $ref: '#/definitions/dto.ErrorDto'
      summary: List all application configurations
      tags:
      - Application Configuration
  /api/application-configuration/sync-ldap:
    post:
      description: Manually trigger LDAP synchronization
      responses:
        "204":
          description: No Content
      summary: Synchronize LDAP
      tags:
      - Application Configuration
  /api/application-configuration/test-email:
    post:
      description: Send a test email to verify email configuration
      responses:
        "204":
          description: No Content
        default:
          description: Error
          schema:
            $ref: '#/definitions/dto.ErrorDto'
      summary: Send test email
      tags:
      - Application Configuration
  /api/application-images/background:
    delete:
      description: Delete the application background image
      responses:
        "204":
          description: No Content
        default:
          description: Error
          schema:
            $ref: '#/definitions/dto.ErrorDto'
      summary: Delete background image
      tags:
      - Application Images
    get:
      description: Get the background image for the application
      produces:
      - image/png
      - image/jpeg
      responses:
        "200":
          description: Background image
          schema:
            type: file
        default:
          description: Error
          schema:
            $ref: '#/definitions/dto.ErrorDto'
      summary: Get background image
      tags:
      - Application Images
    put:
      consumes:
      - multipart/form-data
      description: Update the application background image
      parameters:
      - description: Background image file
        in: formData
        name: file
        required: true
        type: file
      responses:
        "204":
          description: No Content
        default:
          description: Error
          schema:
            $ref: '#/definitions/dto.ErrorDto'
      summary: Update background image
      tags:
      - Application Images
  /api/application-images/default-profile-picture:
    delete:
      description: Delete the default profile picture image
      responses:
        "204":
          description: No Content
        default:
          description: Error
          schema:
            $ref: '#/definitions/dto.ErrorDto'
      summary: Delete default profile picture image
      tags:
      - Application Images
    get:
      description: Get the default profile picture image for the application
      produces:
      - image/png
      - image/jpeg
      responses:
        "200":
          description: Default profile picture image
          schema:
            type: file
        default:
          description: Error
          schema:
            $ref: '#/definitions/dto.ErrorDto'
      summary: Get default profile picture image
      tags:
      - Application Images
    put:
      consumes:
      - multipart/form-data
      description: Update the default profile picture image
      parameters:
      - description: Profile picture image file
        in: formData
        name: file
        required: true
        type: file
      responses:
        "204":
          description: No Content
        default:
          description: Error
          schema:
            $ref: '#/definitions/dto.ErrorDto'
      summary: Update default profile picture image
      tags:
      - Application Images
  /api/application-images/email:
    get:
      description: Get the email logo image for use in emails
      produces:
      - image/png
      - image/jpeg
      responses:
        "200":
          description: Email logo image
          schema:
            type: file
        default:
          description: Error
          schema:
            $ref: '#/definitions/dto.ErrorDto'
      summary: Get email logo image
      tags:
      - Application Images
    put:
      consumes:
      - multipart/form-data
      description: Update the email logo for use in emails
      parameters:
      - description: Email logo image file
        in: formData
        name: file
        required: true
        type: file
      responses:
        "204":
          description: No Content
        default:
          description: Error
          schema:
            $ref: '#/definitions/dto.ErrorDto'
      summary: Update email logo
      tags:
      - Application Images
  /api/application-images/favicon:
    get:
      description: Get the favicon for the application
      produces:
      - image/x-icon
      responses:
        "200":
          description: Favicon image
          schema:
            type: file
        default:
          description: Error
          schema:
            $ref: '#/definitions/dto.ErrorDto'
      summary: Get favicon
      tags:
      - Application Images
    put:
      consumes:
      - multipart/form-data
      description: Update the application favicon
      parameters:
      - description: Favicon file (.svg/.png/.ico)
        in: formData
        name: file
        required: true
        type: file
      responses:
        "204":
          description: No Content
        default:
          description: Error
          schema:
            $ref: '#/definitions/dto.ErrorDto'
      summary: Update favicon
      tags:
      - Application Images
  /api/application-images/logo:
    delete:
      description: Delete the custom application logo and restore the default logo
      parameters:
      - description: Light mode logo (true) or dark mode logo (false)
        in: query
        name: light
        type: boolean
      responses:
        "204":
          description: No Content
        default:
          description: Error
          schema:
            $ref: '#/definitions/dto.ErrorDto'
      summary: Delete logo image
      tags:
      - Application Images
    get:
      description: Get the logo image for the application
      parameters:
      - description: Light mode logo (true) or dark mode logo (false)
        in: query
        name: light
        type: boolean
      - description: Return the bundled default logo if no custom logo is set (default
          true)
        in: query
        name: default
        type: boolean
      produces:
      - image/png
      - image/jpeg
      - image/svg+xml
      responses:
        "200":
          description: Logo image
          schema:
            type: file
        default:
          description: Error
          schema:
            $ref: '#/definitions/dto.ErrorDto'
      summary: Get logo image
      tags:
      - Application Images
    put:
      consumes:
      - multipart/form-data
      description: Update the application logo
      parameters:
      - description: Light mode logo (true) or dark mode logo (false)
        in: query
        name: light
        type: boolean
      - description: Logo image file
        in: formData
        name: file
        required: true
        type: file
      responses:
        "204":
          description: No Content
        default:
          description: Error
          schema:
            $ref: '#/definitions/dto.ErrorDto'
      summary: Update logo
      tags:
      - Application Images
  /api/audit-logs:
    get:
      description: Get a paginated list of audit logs for the current user
      parameters:
      - default: 1
        description: Page number for pagination
        in: query
        name: pagination[page]
        type: integer
      - default: 20
        description: Number of items per page
        in: query
        name: pagination[limit]
        type: integer
      - description: Column to sort by
        in: query
        name: sort[column]
        type: string
      - default: '"asc"'
        description: Sort direction (asc or desc)
        in: query
        name: sort[direction]
        type: string
      responses:
        "200":
          description: OK
          schema:
            $ref: '#/definitions/github_com_pocket-id_pocket-id_backend_internal_dto.Paginated-auditlogs_auditLogDto'
        default:
          description: Error
          schema:
            $ref: '#/definitions/dto.ErrorDto'
      summary: List audit logs
      tags:
      - Audit Logs
  /api/audit-logs/all:
    get:
      description: Get a paginated list of all audit logs (admin only)
      parameters:
      - default: 1
        description: Page number for pagination
        in: query
        name: pagination[page]
        type: integer
      - default: 20
        description: Number of items per page
        in: query
        name: pagination[limit]
        type: integer
      - description: Column to sort by
        in: query
        name: sort[column]
        type: string
      - default: '"asc"'
        description: Sort direction (asc or desc)
        in: query
        name: sort[direction]
        type: string
      responses:
        "200":
          description: OK
          schema:
            $ref: '#/definitions/github_com_pocket-id_pocket-id_backend_internal_dto.Paginated-auditlogs_auditLogDto'
        default:
          description: Error
          schema:
            $ref: '#/definitions/dto.ErrorDto'
      summary: List all audit logs
      tags:
      - Audit Logs
  /api/audit-logs/filters/client-names:
    get:
      description: Get a list of all client names for audit log filtering
      responses:
        "200":
          description: List of client names
          schema:
            items:
              type: string
            type: array
        default:
          description: Error
          schema:
            $ref: '#/definitions/dto.ErrorDto'
      summary: List client names
      tags:
      - Audit Logs
  /api/audit-logs/filters/users:
    get:
      description: Get a list of all usernames with their IDs for audit log filtering
      responses:
        "200":
          description: Map of user IDs to usernames
          schema:
            additionalProperties:
              type: string
            type: object
        default:
          description: Error
          schema:
            $ref: '#/definitions/dto.ErrorDto'
      summary: List users with IDs
      tags:
      - Audit Logs
  /api/custom-claims/suggestions:
    get:
      description: Get a list of suggested custom claim names
      produces:
      - application/json
      responses:
        "200":
          description: List of suggested custom claim names
          schema:
            items:
              type: string
            type: array
        default:
          description: Error
          schema:
            $ref: '#/definitions/dto.ErrorDto'
      summary: Get custom claim suggestions
      tags:
      - Custom Claims
  /api/custom-claims/user-group/{userGroupId}:
    put:
      consumes:
      - application/json
      description: Update or create custom claims for a specific user group
      parameters:
      - description: User Group ID
        in: path
        name: userGroupId
        required: true
        type: string
      - description: List of custom claims to set for the user group
        in: body
        name: claims
        required: true
        schema:
          items:
            $ref: '#/definitions/dto.CustomClaimCreateDto'
          type: array
      produces:
      - application/json
      responses:
        "200":
          description: Updated custom claims
          schema:
            items:
              $ref: '#/definitions/dto.CustomClaimDto'
            type: array
        default:
          description: Error
          schema:
            $ref: '#/definitions/dto.ErrorDto'
      summary: Update custom claims for a user group
      tags:
      - Custom Claims
  /api/custom-claims/user/{userId}:
    put:
      consumes:
      - application/json
      description: Update or create custom claims for a specific user
      parameters:
      - description: User ID
        in: path
        name: userId
        required: true
        type: string
      - description: List of custom claims to set for the user
        in: body
        name: claims
        required: true
        schema:
          items:
            $ref: '#/definitions/dto.CustomClaimCreateDto'
          type: array
      produces:
      - application/json
      responses:
        "200":
          description: Updated custom claims
          schema:
            items:
              $ref: '#/definitions/dto.CustomClaimDto'
            type: array
        default:
          description: Error
          schema:
            $ref: '#/definitions/dto.ErrorDto'
      summary: Update custom claims for a user
      tags:
      - Custom Claims
  /api/device-login/requests:
    post:
      description: Create a short-lived request that can be approved from another
        authenticated device
      produces:
      - application/json
      responses:
        "201":
          description: Created device login request
          schema:
            $ref: '#/definitions/devicelogin.requestCreateDto'
      summary: Create device login request
      tags:
      - Device Login
  /api/device-login/requests/{id}/exchange:
    post:
      description: Wait for a device login decision and create a browser session after
        it has been approved
      parameters:
      - description: Device login request ID
        in: path
        name: id
        required: true
        type: string
      produces:
      - application/json
      responses:
        "200":
          description: Approved request exchanged for a user session
          schema:
            $ref: '#/definitions/dto.UserDto'
        "202":
          description: Authorization pending
      summary: Exchange device login request
      tags:
      - Device Login
  /api/device-login/verification:
    post:
      consumes:
      - application/json
      description: Retrieve the requesting device details for an authenticated user
        before approval or denial
      parameters:
      - description: Device login code
        in: body
        name: request
        required: true
        schema:
          $ref: '#/definitions/devicelogin.verificationDto'
      produces:
      - application/json
      responses:
        "200":
          description: Device login request details
          schema:
            $ref: '#/definitions/devicelogin.verificationInfoDto'
      summary: Inspect device login request
      tags:
      - Device Login
  /api/device-login/verification/decision:
    post:
      consumes:
      - application/json
      description: Approve or deny a device login request; approval requires fresh
        passkey reauthentication
      parameters:
      - description: Device login decision
        in: body
        name: decision
        required: true
        schema:
          $ref: '#/definitions/devicelogin.decisionDto'
      responses:
        "204":
          description: No Content
      summary: Decide device login request
      tags:
      - Device Login
  /api/oidc/clients:
    get:
      description: Get a paginated list of OIDC clients with optional search and sorting
      parameters:
      - description: Search term to filter clients by name
        in: query
        name: search
        type: string
      - default: 1
        description: Page number for pagination
        in: query
        name: pagination[page]
        type: integer
      - default: 20
        description: Number of items per page
        in: query
        name: pagination[limit]
        type: integer
      - description: Column to sort by
        in: query
        name: sort[column]
        type: string
      - default: '"asc"'
        description: Sort direction (asc or desc)
        in: query
        name: sort[direction]
        type: string
      responses:
        "200":
          description: OK
          schema:
            $ref: '#/definitions/github_com_pocket-id_pocket-id_backend_internal_dto.Paginated-dto_OidcClientWithAllowedGroupsDto'
        default:
          description: Error
          schema:
            $ref: '#/definitions/dto.ErrorDto'
      summary: List OIDC clients
      tags:
      - OIDC
    post:
      consumes:
      - application/json
      description: Create a new OIDC client
      parameters:
      - description: Client information
        in: body
        name: client
        required: true
        schema:
          $ref: '#/definitions/dto.OidcClientCreateDto'
      produces:
      - application/json
      responses:
        "201":
          description: Created client
          schema:
            $ref: '#/definitions/dto.OidcClientCreatedDto'
        default:
          description: Error
          schema:
            $ref: '#/definitions/dto.ErrorDto'
      summary: Create OIDC client
      tags:
      - OIDC
  /api/oidc/clients/{id}:
    delete:
      description: Delete an OIDC client by ID
      parameters:
      - description: Client ID
        in: path
        name: id
        required: true
        type: string
      responses:
        "204":
          description: No Content
        default:
          description: Error
          schema:
            $ref: '#/definitions/dto.ErrorDto'
      summary: Delete OIDC client
      tags:
      - OIDC
    get:
      description: Get detailed information about an OIDC client
      parameters:
      - description: Client ID
        in: path
        name: id
        required: true
        type: string
      produces:
      - application/json
      responses:
        "200":
          description: Client information
          schema:
            $ref: '#/definitions/dto.OidcClientWithAllowedUserGroupsDto'
        default:
          description: Error
          schema:
            $ref: '#/definitions/dto.ErrorDto'
      summary: Get OIDC client
      tags:
      - OIDC
    put:
      consumes:
      - application/json
      description: Update an existing OIDC client
      parameters:
      - description: Client ID
        in: path
        name: id
        required: true
        type: string
      - description: Client information
        in: body
        name: client
        required: true
        schema:
          $ref: '#/definitions/dto.OidcClientUpdateDto'
      produces:
      - application/json
      responses:
        "200":
          description: Updated client
          schema:
            $ref: '#/definitions/dto.OidcClientWithAllowedUserGroupsDto'
        default:
          description: Error
          schema:
            $ref: '#/definitions/dto.ErrorDto'
      summary: Update OIDC client
      tags:
      - OIDC
  /api/oidc/clients/{id}/allowed-user-groups:
    put:
      consumes:
      - application/json
      description: Update the user groups allowed to access an OIDC client
      parameters:
      - description: Client ID
        in: path
        name: id
        required: true
        type: string
      - description: User group IDs
        in: body
        name: groups
        required: true
        schema:
          $ref: '#/definitions/dto.OidcUpdateAllowedUserGroupsDto'
      produces:
      - application/json
      responses:
        "200":
          description: Updated client
          schema:
            $ref: '#/definitions/dto.OidcClientDto'
        default:
          description: Error
          schema:
            $ref: '#/definitions/dto.ErrorDto'
      summary: Update allowed user groups
      tags:
      - OIDC
  /api/oidc/clients/{id}/logo:
    delete:
      description: Delete the logo for an OIDC client
      parameters:
      - description: Client ID
        in: path
        name: id
        required: true
        type: string
      - description: Light mode logo (true) or dark mode logo (false)
        in: query
        name: light
        type: boolean
      responses:
        "204":
          description: No Content
        default:
          description: Error
          schema:
            $ref: '#/definitions/dto.ErrorDto'
      summary: Delete client logo
      tags:
      - OIDC
    get:
      description: Get the logo image for an OIDC client
      parameters:
      - description: Client ID
        in: path
        name: id
        required: true
        type: string
      - description: Light mode logo (true) or dark mode logo (false)
        in: query
        name: light
        type: boolean
      produces:
      - image/png
      - image/jpeg
      - image/svg+xml
      responses:
        "200":
          description: Logo image
          schema:
            type: file
        default:
          description: Error
          schema:
            $ref: '#/definitions/dto.ErrorDto'
      summary: Get client logo
      tags:
      - OIDC
    post:
      consumes:
      - multipart/form-data
      description: Upload or update the logo for an OIDC client
      parameters:
      - description: Client ID
        in: path
        name: id
        required: true
        type: string
      - description: Logo image file (PNG, JPG, or SVG)
        in: formData
        name: file
        required: true
        type: file
      - description: Light mode logo (true) or dark mode logo (false)
        in: query
        name: light
        type: boolean
      responses:
        "204":
          description: No Content
        default:
          description: Error
          schema:
            $ref: '#/definitions/dto.ErrorDto'
      summary: Update client logo
      tags:
      - OIDC
  /api/oidc/clients/{id}/preview/{userId}:
    get:
      description: Get a preview of the OIDC data (ID token, access token, userinfo)
        that would be sent to the client for a specific user
      parameters:
      - description: Client ID
        in: path
        name: id
        required: true
        type: string
      - description: User ID to preview data for
        in: path
        name: userId
        required: true
        type: string
      - description: Scopes to include in the preview (comma-separated)
        in: query
        name: scopes
        type: string
      produces:
      - application/json
      responses:
        "200":
          description: Preview data including ID token, access token, and userinfo
            payloads
          schema:
            $ref: '#/definitions/dto.OidcClientPreviewDto'
        default:
          description: Error
          schema:
            $ref: '#/definitions/dto.ErrorDto'
      security:
      - BearerAuth: []
      summary: Preview OIDC client data for user
      tags:
      - OIDC
  /api/oidc/clients/{id}/refresh:
    post:
      description: Force a re-fetch of the OAuth Client ID Metadata Document for a
        CIMD client
      parameters:
      - description: Client ID
        in: path
        name: id
        required: true
        type: string
      produces:
      - application/json
      responses:
        "200":
          description: Refreshed client
          schema:
            $ref: '#/definitions/dto.OidcClientWithAllowedUserGroupsDto'
        default:
          description: Error
          schema:
            $ref: '#/definitions/dto.ErrorDto'
      summary: Refresh client metadata document
      tags:
      - OIDC
  /api/oidc/clients/{id}/scim-service-provider:
    get:
      description: Get the SCIM service provider configuration for an OIDC client
      parameters:
      - description: Client ID
        in: path
        name: id
        required: true
        type: string
      produces:
      - application/json
      responses:
        "200":
          description: SCIM service provider configuration
          schema:
            $ref: '#/definitions/scimsync.ScimServiceProviderDTO'
        default:
          description: Error
          schema:
            $ref: '#/definitions/dto.ErrorDto'
      summary: Get SCIM service provider
      tags:
      - OIDC
  /api/oidc/clients/{id}/secrets:
    get:
      description: List the secrets of an OIDC client, without disclosing their values
      parameters:
      - description: Client ID
        in: path
        name: id
        required: true
        type: string
      produces:
      - application/json
      responses:
        "200":
          description: Client secrets
          schema:
            items:
              $ref: '#/definitions/dto.OidcClientSecretDto'
            type: array
        default:
          description: Error
          schema:
            $ref: '#/definitions/dto.ErrorDto'
      summary: List client secrets
      tags:
      - OIDC
    post:
      consumes:
      - application/json
      description: Add a new secret to an OIDC client, leaving the existing ones usable.
        The value is only returned by this endpoint and cannot be retrieved later.
      parameters:
      - description: Client ID
        in: path
        name: id
        required: true
        type: string
      - description: Client secret
        in: body
        name: payload
        schema:
          $ref: '#/definitions/dto.OidcClientSecretCreateDto'
      produces:
      - application/json
      responses:
        "201":
          description: Created client secret
          schema:
            $ref: '#/definitions/dto.OidcClientSecretCreatedDto'
        default:
          description: Error
          schema:
            $ref: '#/definitions/dto.ErrorDto'
      summary: Create client secret
      tags:
      - OIDC
  /api/oidc/clients/{id}/secrets/{secretId}:
    delete:
      description: Delete a single secret of an OIDC client, making it immediately
        unusable
      parameters:
      - description: Client ID
        in: path
        name: id
        required: true
        type: string
      - description: Client secret ID
        in: path
        name: secretId
        required: true
        type: string
      responses:
        "204":
          description: No content
        default:
          description: Error
          schema:
            $ref: '#/definitions/dto.ErrorDto'
      summary: Delete client secret
      tags:
      - OIDC
  /api/oidc/introspect:
    post:
      description: Pass a token to verify if it is considered valid.
      parameters:
      - description: The token to be introspected.
        in: formData
        name: token
        required: true
        type: string
      produces:
      - application/json
      responses:
        "200":
          description: Response with the introspection result.
          schema:
            type: object
      summary: Introspect OIDC tokens
      tags:
      - OIDC
  /api/oidc/logo-presets:
    get:
      description: Search the icon library for logos that can be used for OIDC clients
      parameters:
      - description: Search term matched against the icon name
        in: query
        name: search
        type: string
      produces:
      - application/json
      responses:
        "200":
          description: OK
          schema:
            items:
              $ref: '#/definitions/logopreset.logoPresetDto'
            type: array
        default:
          description: Error
          schema:
            $ref: '#/definitions/dto.ErrorDto'
      summary: Search logo presets
      tags:
      - OIDC
  /api/oidc/userinfo:
    get:
      consumes:
      - application/json
      description: Get user information based on the access token
      produces:
      - application/json
      responses:
        "200":
          description: User claims based on requested scopes
          schema:
            type: object
      security:
      - OAuth2AccessToken: []
      summary: Get user information
      tags:
      - OIDC
  /api/oidc/users/{id}/authorized-clients:
    get:
      description: Get a paginated list of OIDC clients that a specific user has authorized
      parameters:
      - description: User ID
        in: path
        name: id
        required: true
        type: string
      - description: Search term to filter clients by name
        in: query
        name: search
        type: string
      - default: 1
        description: Page number for pagination
        in: query
        name: pagination[page]
        type: integer
      - default: 20
        description: Number of items per page
        in: query
        name: pagination[limit]
        type: integer
      - description: Column to sort by (name or lastUsedAt)
        in: query
        name: sort[column]
        type: string
      - default: '"asc"'
        description: Sort direction (asc or desc)
        in: query
        name: sort[direction]
        type: string
      - description: Filter clients by whether a launch URL is configured
        in: query
        name: filters[hasLaunchURL]
        type: boolean
      responses:
        "200":
          description: OK
          schema:
            $ref: '#/definitions/github_com_pocket-id_pocket-id_backend_internal_dto.Paginated-dto_AuthorizedOidcClientDto'
        default:
          description: Error
          schema:
            $ref: '#/definitions/dto.ErrorDto'
      summary: List authorized clients for a user
      tags:
      - OIDC
  /api/oidc/users/me/authorized-clients:
    get:
      description: Get a paginated list of OIDC clients that the current user has
        authorized
      parameters:
      - description: Search term to filter clients by name
        in: query
        name: search
        type: string
      - default: 1
        description: Page number for pagination
        in: query
        name: pagination[page]
        type: integer
      - default: 20
        description: Number of items per page
        in: query
        name: pagination[limit]
        type: integer
      - description: Column to sort by (name or lastUsedAt)
        in: query
        name: sort[column]
        type: string
      - default: '"asc"'
        description: Sort direction (asc or desc)
        in: query
        name: sort[direction]
        type: string
      - description: Filter clients by whether a launch URL is configured
        in: query
        name: filters[hasLaunchURL]
        type: boolean
      responses:
        "200":
          description: OK
          schema:
            $ref: '#/definitions/github_com_pocket-id_pocket-id_backend_internal_dto.Paginated-dto_AuthorizedOidcClientDto'
        default:
          description: Error
          schema:
            $ref: '#/definitions/dto.ErrorDto'
      summary: List authorized clients for current user
      tags:
      - OIDC
  /api/oidc/users/me/authorized-clients/{clientId}:
    delete:
      description: Revoke the authorization for a specific OIDC client for the current
        user
      parameters:
      - description: Client ID to revoke authorization for
        in: path
        name: clientId
        required: true
        type: string
      responses:
        "204":
          description: No Content
        default:
          description: Error
          schema:
            $ref: '#/definitions/dto.ErrorDto'
      summary: Revoke authorization for an OIDC client
      tags:
      - OIDC
  /api/oidc/users/me/clients:
    get:
      description: Get a list of OIDC clients that the current user can access
      parameters:
      - description: Search term to filter clients by name
        in: query
        name: search
        type: string
      - default: 1
        description: Page number for pagination
        in: query
        name: pagination[page]
        type: integer
      - default: 20
        description: Number of items per page
        in: query
        name: pagination[limit]
        type: integer
      - description: Column to sort by (name or lastUsedAt)
        in: query
        name: sort[column]
        type: string
      - default: '"asc"'
        description: Sort direction (asc or desc)
        in: query
        name: sort[direction]
        type: string
      - description: Filter clients by whether a launch URL is configured
        in: query
        name: filters[hasLaunchURL]
        type: boolean
      responses:
        "200":
          description: OK
          schema:
            $ref: '#/definitions/github_com_pocket-id_pocket-id_backend_internal_dto.Paginated-dto_AccessibleOidcClientDto'
        default:
          description: Error
          schema:
            $ref: '#/definitions/dto.ErrorDto'
      summary: List accessible OIDC clients for current user
      tags:
      - OIDC
  /api/one-time-access-email:
    post:
      consumes:
      - application/json
      description: Request a one-time access email for unauthenticated users
      parameters:
      - description: Email request information
        in: body
        name: body
        required: true
        schema:
          $ref: '#/definitions/onetimeaccess.emailAsUnauthenticatedUserDto'
      produces:
      - application/json
      responses:
        "204":
          description: No Content
      summary: Request one-time access email
      tags:
      - Users
  /api/one-time-access-token/{token}:
    post:
      description: Exchange a one-time access token for a session token
      parameters:
      - description: One-time access token
        in: path
        name: token
        required: true
        type: string
      responses:
        "200":
          description: OK
          schema:
            $ref: '#/definitions/dto.UserDto'
      summary: Exchange one-time access token
      tags:
      - Users
  /api/scim/service-provider:
    post:
      consumes:
      - application/json
      description: Create a new SCIM service provider
      parameters:
      - description: SCIM service provider information
        in: body
        name: serviceProvider
        required: true
        schema:
          $ref: '#/definitions/scimsync.ScimServiceProviderCreateDTO'
      produces:
      - application/json
      responses:
        "201":
          description: Created SCIM service provider
          schema:
            $ref: '#/definitions/scimsync.ScimServiceProviderDTO'
        default:
          description: Error
          schema:
            $ref: '#/definitions/dto.ErrorDto'
      summary: Create SCIM service provider
      tags:
      - SCIM
  /api/scim/service-provider/{id}:
    delete:
      description: Delete a SCIM service provider by ID
      parameters:
      - description: Service Provider ID
        in: path
        name: id
        required: true
        type: string
      responses:
        "204":
          description: No Content
        default:
          description: Error
          schema:
            $ref: '#/definitions/dto.ErrorDto'
      summary: Delete SCIM service provider
      tags:
      - SCIM
    put:
      consumes:
      - application/json
      description: Update an existing SCIM service provider
      parameters:
      - description: Service Provider ID
        in: path
        name: id
        required: true
        type: string
      - description: SCIM service provider information
        in: body
        name: serviceProvider
        required: true
        schema:
          $ref: '#/definitions/scimsync.ScimServiceProviderCreateDTO'
      produces:
      - application/json
      responses:
        "200":
          description: Updated SCIM service provider
          schema:
            $ref: '#/definitions/scimsync.ScimServiceProviderDTO'
        default:
          description: Error
          schema:
            $ref: '#/definitions/dto.ErrorDto'
      summary: Update SCIM service provider
      tags:
      - SCIM
  /api/scim/service-provider/{id}/sync:
    post:
      description: Trigger synchronization for a SCIM service provider
      parameters:
      - description: Service Provider ID
        in: path
        name: id
        required: true
        type: string
      responses:
        "200":
          description: OK
        default:
          description: Error
          schema:
            $ref: '#/definitions/dto.ErrorDto'
      summary: Sync SCIM service provider
      tags:
      - SCIM
  /api/signup:
    post:
      consumes:
      - application/json
      description: Create a new user account
      parameters:
      - description: User information
        in: body
        name: user
        required: true
        schema:
          $ref: '#/definitions/usersignup.signUpDto'
      produces:
      - application/json
      responses:
        "201":
          description: Created
          schema:
            $ref: '#/definitions/dto.UserDto'
      summary: Sign up
      tags:
      - Users
  /api/signup-tokens:
    get:
      description: Get a paginated list of signup tokens
      parameters:
      - default: 1
        description: Page number for pagination
        in: query
        name: pagination[page]
        type: integer
      - default: 20
        description: Number of items per page
        in: query
        name: pagination[limit]
        type: integer
      - description: Column to sort by
        in: query
        name: sort[column]
        type: string
      - default: '"asc"'
        description: Sort direction (asc or desc)
        in: query
        name: sort[direction]
        type: string
      responses:
        "200":
          description: OK
          schema:
            $ref: '#/definitions/github_com_pocket-id_pocket-id_backend_internal_dto.Paginated-usersignup_signupTokenDto'
      summary: List signup tokens
      tags:
      - Users
    post:
      consumes:
      - application/json
      description: Create a new signup token that allows user registration
      parameters:
      - description: Signup token information
        in: body
        name: token
        required: true
        schema:
          $ref: '#/definitions/usersignup.signupTokenCreateDto'
      produces:
      - application/json
      responses:
        "201":
          description: Created
          schema:
            $ref: '#/definitions/usersignup.signupTokenDto'
      summary: Create signup token
      tags:
      - Users
  /api/signup-tokens/{id}:
    delete:
      description: Delete a signup token by ID
      parameters:
      - description: Token ID
        in: path
        name: id
        required: true
        type: string
      responses:
        "204":
          description: No Content
      summary: Delete signup token
      tags:
      - Users
  /api/signup/setup:
    post:
      consumes:
      - application/json
      description: Sign up and generate setup access token for initial admin user
      parameters:
      - description: User information
        in: body
        name: body
        required: true
        schema:
          $ref: '#/definitions/usersignup.signUpDto'
      produces:
      - application/json
      responses:
        "200":
          description: OK
          schema:
            $ref: '#/definitions/dto.UserDto'
      summary: Sign up initial admin user
      tags:
      - Users
  /api/storage/sqlite-warning:
    get:
      description: Reports whether Pocket ID found its SQLite database on a networked
        filesystem, which is unsupported and can lead to database corruption
      produces:
      - application/json
      responses:
        "200":
          description: SQLite storage warning state
          schema:
            additionalProperties:
              type: boolean
            type: object
        default:
          description: Error
          schema:
            $ref: '#/definitions/dto.ErrorDto'
      summary: Get whether the SQLite storage warning should be shown
      tags:
      - Storage
  /api/user-groups:
    get:
      description: Get a paginated list of user groups with optional search and sorting
      parameters:
      - description: Search term to filter user groups by name
        in: query
        name: search
        type: string
      - default: 1
        description: Page number for pagination
        in: query
        name: pagination[page]
        type: integer
      - default: 20
        description: Number of items per page
        in: query
        name: pagination[limit]
        type: integer
      - description: Column to sort by
        in: query
        name: sort[column]
        type: string
      - default: '"asc"'
        description: Sort direction (asc or desc)
        in: query
        name: sort[direction]
        type: string
      responses:
        "200":
          description: OK
          schema:
            $ref: '#/definitions/github_com_pocket-id_pocket-id_backend_internal_dto.Paginated-dto_UserGroupMinimalDto'
        default:
          description: Error
          schema:
            $ref: '#/definitions/dto.ErrorDto'
      summary: List user groups
      tags:
      - User Groups
    post:
      consumes:
      - application/json
      description: Create a new user group
      parameters:
      - description: User group information
        in: body
        name: userGroup
        required: true
        schema:
          $ref: '#/definitions/dto.UserGroupCreateDto'
      produces:
      - application/json
      responses:
        "201":
          description: Created user group
          schema:
            $ref: '#/definitions/dto.UserGroupDto'
        default:
          description: Error
          schema:
            $ref: '#/definitions/dto.ErrorDto'
      summary: Create user group
      tags:
      - User Groups
  /api/user-groups/{id}:
    delete:
      consumes:
      - application/json
      description: Delete a specific user group by ID
      parameters:
      - description: User Group ID
        in: path
        name: id
        required: true
        type: string
      produces:
      - application/json
      responses:
        "204":
          description: No Content
        default:
          description: Error
          schema:
            $ref: '#/definitions/dto.ErrorDto'
      summary: Delete user group
      tags:
      - User Groups
    get:
      consumes:
      - application/json
      description: Retrieve detailed information about a specific user group including
        its users
      parameters:
      - description: User Group ID
        in: path
        name: id
        required: true
        type: string
      produces:
      - application/json
      responses:
        "200":
          description: OK
          schema:
            $ref: '#/definitions/dto.UserGroupDto'
        default:
          description: Error
          schema:
            $ref: '#/definitions/dto.ErrorDto'
      summary: Get user group by ID
      tags:
      - User Groups
    put:
      consumes:
      - application/json
      description: Update an existing user group by ID
      parameters:
      - description: User Group ID
        in: path
        name: id
        required: true
        type: string
      - description: User group information
        in: body
        name: userGroup
        required: true
        schema:
          $ref: '#/definitions/dto.UserGroupCreateDto'
      produces:
      - application/json
      responses:
        "200":
          description: Updated user group
          schema:
            $ref: '#/definitions/dto.UserGroupDto'
        default:
          description: Error
          schema:
            $ref: '#/definitions/dto.ErrorDto'
      summary: Update user group
      tags:
      - User Groups
  /api/user-groups/{id}/allowed-oidc-clients:
    put:
      consumes:
      - application/json
      description: Update the OIDC clients allowed for a specific user group
      parameters:
      - description: User Group ID
        in: path
        name: id
        required: true
        type: string
      - description: OIDC client IDs to allow
        in: body
        name: groups
        required: true
        schema:
          $ref: '#/definitions/dto.UserGroupUpdateAllowedOidcClientsDto'
      produces:
      - application/json
      responses:
        "200":
          description: Updated user group
          schema:
            $ref: '#/definitions/dto.UserGroupDto'
        default:
          description: Error
          schema:
            $ref: '#/definitions/dto.ErrorDto'
      summary: Update allowed OIDC clients
      tags:
      - OIDC
  /api/user-groups/{id}/users:
    put:
      consumes:
      - application/json
      description: Update the list of users belonging to a specific user group
      parameters:
      - description: User Group ID
        in: path
        name: id
        required: true
        type: string
      - description: List of user IDs to assign to this group
        in: body
        name: users
        required: true
        schema:
          $ref: '#/definitions/dto.UserGroupUpdateUsersDto'
      produces:
      - application/json
      responses:
        "200":
          description: OK
          schema:
            $ref: '#/definitions/dto.UserGroupDto'
        default:
          description: Error
          schema:
            $ref: '#/definitions/dto.ErrorDto'
      summary: Update users in a group
      tags:
      - User Groups
  /api/users:
    get:
      description: Get a paginated list of users with optional search and sorting
      parameters:
      - description: Search term to filter users
        in: query
        name: search
        type: string
      - default: 1
        description: Page number for pagination
        in: query
        name: pagination[page]
        type: integer
      - default: 20
        description: Number of items per page
        in: query
        name: pagination[limit]
        type: integer
      - description: Column to sort by
        in: query
        name: sort[column]
        type: string
      - default: '"asc"'
        description: Sort direction (asc or desc)
        in: query
        name: sort[direction]
        type: string
      responses:
        "200":
          description: OK
          schema:
            $ref: '#/definitions/github_com_pocket-id_pocket-id_backend_internal_dto.Paginated-dto_UserDto'
        default:
          description: Error
          schema:
            $ref: '#/definitions/dto.ErrorDto'
      summary: List users
      tags:
      - Users
    post:
      description: Create a new user
      parameters:
      - description: User information
        in: body
        name: user
        required: true
        schema:
          $ref: '#/definitions/dto.UserCreateDto'
      responses:
        "201":
          description: Created
          schema:
            $ref: '#/definitions/dto.UserDto'
        default:
          description: Error
          schema:
            $ref: '#/definitions/dto.ErrorDto'
      summary: Create user
      tags:
      - Users
  /api/users/{id}:
    delete:
      description: Delete a specific user by ID
      parameters:
      - description: User ID
        in: path
        name: id
        required: true
        type: string
      responses:
        "204":
          description: No Content
        default:
          description: Error
          schema:
            $ref: '#/definitions/dto.ErrorDto'
      summary: Delete user
      tags:
      - Users
    get:
      description: Retrieve detailed information about a specific user
      parameters:
      - description: User ID
        in: path
        name: id
        required: true
        type: string
      responses:
        "200":
          description: OK
          schema:
            $ref: '#/definitions/dto.UserDto'
        default:
          description: Error
          schema:
            $ref: '#/definitions/dto.ErrorDto'
      summary: Get user by ID
      tags:
      - Users
    put:
      description: Update an existing user by ID
      parameters:
      - description: User ID
        in: path
        name: id
        required: true
        type: string
      - description: User information
        in: body
        name: user
        required: true
        schema:
          $ref: '#/definitions/dto.UserCreateDto'
      responses:
        "200":
          description: OK
          schema:
            $ref: '#/definitions/dto.UserDto'
        default:
          description: Error
          schema:
            $ref: '#/definitions/dto.ErrorDto'
      summary: Update user
      tags:
      - Users
  /api/users/{id}/groups:
    get:
      description: Retrieve all groups a specific user belongs to
      parameters:
      - description: User ID
        in: path
        name: id
        required: true
        type: string
      responses:
        "200":
          description: OK
          schema:
            items:
              $ref: '#/definitions/dto.UserGroupDto'
            type: array
        default:
          description: Error
          schema:
            $ref: '#/definitions/dto.ErrorDto'
      summary: Get user groups
      tags:
      - Users
      - User Groups
  /api/users/{id}/one-time-access-email:
    post:
      consumes:
      - application/json
      description: Request a one-time access email for a specific user (admin only)
      parameters:
      - description: User ID
        in: path
        name: id
        required: true
        type: string
      - description: Email request options
        in: body
        name: body
        required: true
        schema:
          $ref: '#/definitions/onetimeaccess.emailAsAdminDto'
      produces:
      - application/json
      responses:
        "204":
          description: No Content
      summary: Request one-time access email (admin)
      tags:
      - Users
  /api/users/{id}/one-time-access-token:
    post:
      description: Generate a one-time access token for a specific user (admin only)
      parameters:
      - description: User ID
        in: path
        name: id
        required: true
        type: string
      - description: Token options
        in: body
        name: body
        required: true
        schema:
          $ref: '#/definitions/onetimeaccess.tokenCreateDto'
      responses:
        "201":
          description: '{ \"token\": \"string\" }'
          schema:
            type: object
      summary: Create one-time access token for user (admin)
      tags:
      - Users
  /api/users/{id}/profile-picture:
    delete:
      description: Reset a specific user's profile picture to the default
      parameters:
      - description: User ID
        in: path
        name: id
        required: true
        type: string
      produces:
      - application/json
      responses:
        "204":
          description: No Content
        default:
          description: Error
          schema:
            $ref: '#/definitions/dto.ErrorDto'
      summary: Reset user profile picture
      tags:
      - Users
    put:
      consumes:
      - multipart/form-data
      description: Update a specific user's profile picture
      parameters:
      - description: User ID
        in: path
        name: id
        required: true
        type: string
      - description: Profile picture image file (PNG, JPG, or JPEG)
        in: formData
        name: file
        required: true
        type: file
      produces:
      - application/json
      responses:
        "204":
          description: No Content
        default:
          description: Error
          schema:
            $ref: '#/definitions/dto.ErrorDto'
      summary: Update user profile picture
      tags:
      - Users
  /api/users/{id}/profile-picture.png:
    get:
      description: Retrieve a specific user's profile picture
      parameters:
      - description: User ID
        in: path
        name: id
        required: true
        type: string
      produces:
      - image/png
      responses:
        "200":
          description: PNG image
          schema:
            type: file
        default:
          description: Error
          schema:
            $ref: '#/definitions/dto.ErrorDto'
      summary: Get user profile picture
      tags:
      - Users
  /api/users/{id}/user-groups:
    put:
      description: Update the groups a specific user belongs to
      parameters:
      - description: User ID
        in: path
        name: id
        required: true
        type: string
      - description: User group IDs
        in: body
        name: groups
        required: true
        schema:
          $ref: '#/definitions/dto.UserUpdateUserGroupDto'
      responses:
        "200":
          description: OK
          schema:
            $ref: '#/definitions/dto.UserDto'
        default:
          description: Error
          schema:
            $ref: '#/definitions/dto.ErrorDto'
      summary: Update user groups
      tags:
      - Users
  /api/users/{id}/webauthn-credentials:
    get:
      description: Retrieve all WebAuthn credentials for a specific user
      parameters:
      - description: User ID
        in: path
        name: id
        required: true
        type: string
      responses:
        "200":
          description: OK
          schema:
            items:
              $ref: '#/definitions/dto.WebauthnCredentialDto'
            type: array
        default:
          description: Error
          schema:
            $ref: '#/definitions/dto.ErrorDto'
      summary: List user passkeys
      tags:
      - Users
  /api/users/{id}/webauthn-credentials/{credentialId}:
    delete:
      description: Delete a specific WebAuthn credential for a user
      parameters:
      - description: User ID
        in: path
        name: id
        required: true
        type: string
      - description: Credential ID
        in: path
        name: credentialId
        required: true
        type: string
      responses:
        "204":
          description: No Content
        default:
          description: Error
          schema:
            $ref: '#/definitions/dto.ErrorDto'
      summary: Delete user passkey
      tags:
      - Users
  /api/users/me:
    get:
      description: Retrieve information about the currently authenticated user
      responses:
        "200":
          description: OK
          schema:
            $ref: '#/definitions/dto.UserDto'
        default:
          description: Error
          schema:
            $ref: '#/definitions/dto.ErrorDto'
      summary: Get current user
      tags:
      - Users
    put:
      description: Update the currently authenticated user's information
      parameters:
      - description: User information
        in: body
        name: user
        required: true
        schema:
          $ref: '#/definitions/dto.UserCreateDto'
      responses:
        "200":
          description: OK
          schema:
            $ref: '#/definitions/dto.UserDto'
        default:
          description: Error
          schema:
            $ref: '#/definitions/dto.ErrorDto'
      summary: Update current user
      tags:
      - Users
  /api/users/me/email-change:
    delete:
      description: Cancel the pending email change of the currently authenticated
        user, so its verification link stops working
      responses:
        "204":
          description: No Content
      summary: Cancel pending email change
      tags:
      - Users
    get:
      description: Get the email change of the currently authenticated user that still
        has to be confirmed through the emailed link
      produces:
      - application/json
      responses:
        "200":
          description: OK
          schema:
            $ref: '#/definitions/emailverification.emailChangeDto'
        "204":
          description: No pending email change
      summary: Get pending email change
      tags:
      - Users
  /api/users/me/profile-picture:
    delete:
      description: Reset the currently authenticated user's profile picture to the
        default
      produces:
      - application/json
      responses:
        "204":
          description: No Content
        default:
          description: Error
          schema:
            $ref: '#/definitions/dto.ErrorDto'
      summary: Reset current user's profile picture
      tags:
      - Users
    put:
      consumes:
      - multipart/form-data
      description: Update the currently authenticated user's profile picture
      parameters:
      - description: Profile picture image file (PNG, JPG, or JPEG)
        in: formData
        name: file
        required: true
        type: file
      produces:
      - application/json
      responses:
        "204":
          description: No Content
        default:
          description: Error
          schema:
            $ref: '#/definitions/dto.ErrorDto'
      summary: Update current user's profile picture
      tags:
      - Users
  /api/users/me/send-email-verification:
    post:
      description: Send an email verification to the currently authenticated user
      produces:
      - application/json
      responses:
        "204":
          description: No Content
      summary: Send email verification
      tags:
      - Users
  /api/users/me/verify-email:
    post:
      description: Verify the currently authenticated user's email using a verification
        token
      parameters:
      - description: Email verification token
        in: body
        name: body
        required: true
        schema:
          $ref: '#/definitions/dto.EmailVerificationDto'
      responses:
        "204":
          description: No Content
      summary: Verify email
      tags:
      - Users
  /api/version/current:
    get:
      produces:
      - application/json
      responses:
        "200":
          description: Current version information
          schema:
            additionalProperties:
              type: string
            type: object
        default:
          description: Error
          schema:
            $ref: '#/definitions/dto.ErrorDto'
      summary: Get current deployed version of Pocket ID
      tags:
      - Version
  /api/version/latest:
    get:
      produces:
      - application/json
      responses:
        "200":
          description: Latest version information
          schema:
            additionalProperties:
              type: string
            type: object
        default:
          description: Error
          schema:
            $ref: '#/definitions/dto.ErrorDto'
      summary: Get latest available version of Pocket ID
      tags:
      - Version
  /healthz:
    get:
      description: Responds with a successful status code to healthcheck requests
      responses:
        "204":
          description: ""
        default:
          description: Error
          schema:
            $ref: '#/definitions/dto.ErrorDto'
      summary: Responds to healthchecks
      tags:
      - Health
swagger: "2.0"
