Skip to content

About

No description or website provided.

Topics

Resources

Code of conduct

Contributing

Security policy

Stars

4 stars

Watchers

12 watching

Forks

oCIS PHP SDK

License ownCloud OSPO Docker Hub

A PHP SDK for interacting with ownCloud Infinite Scale. It wraps the Libre Graph API and provides high-level PHP classes for managing drives, files, users, groups, shares, notifications, and application roles on an oCIS instance, with support for both OIDC and education-specific access tokens.

Important

This repository generates its own documentation set that is embedded into the oCIS developer documentation at build time. The final result is published in the official ownCloud documentation.

Whenever SDK-related content in this repository changes, the documentation must be regenerated and committed. Run the following command in your local repo's root:

docker run --rm -v ${PWD}:/data --user $(id -u):$(id -g) phpdoc/phpdoc:3

If you get errors about files or folders that cannot be created, omit --user $(id -u):$(id -g).

After generating the docs (~121 files, ~2.4 MB in total, only a fraction may be changed), commit, push, and merge the changes upstream. Omitting this step means documentation updates will not be published.

Note that the file .nojekyll in the docs/ folder is intentional to tell github not to render the result and present the files as files.

Getting Started

Follow the steps below to install and use the oCIS PHP SDK.

Installation via Composer

composer config minimum-stability dev
composer config prefer-stable true
composer require owncloud/ocis-php-sdk

Usage

use Owncloud\OcisPhpSdk\Ocis;

$ocis = new Ocis('https://example.ocis.com', $accessToken);
$drives = $ocis->getMyDrives();

Run Tests

make test-php-unit
make test-php-style
make test-php-phpstan

Documentation

Part of ownCloud Infinite Scale

This SDK is the recommended way for PHP applications to integrate with oCIS. It is used by the Moodle oCIS plugin and depends on the libre-graph-api-php client.

This component is part of the oCIS Docker image.

Community & Support

Star this repo and Watch for release notifications!

Contributing

We welcome contributions! Please read the Contributing Guidelines and our Code of Conduct before getting started.

Workflow

  • Rebase Early, Rebase Often! We use a rebase workflow. Always rebase on the target branch before submitting a PR.
  • Dependabot: Automated dependency updates are managed via Dependabot. Review and merge dependency PRs promptly.
  • Signed Commits: All commits must be PGP/GPG signed. See GitHub's signing guide.
  • DCO Sign-off: Every commit must carry a Signed-off-by line:
    git commit -s -S -m "your commit message"
    
  • GitHub Actions Policy: Workflows may only use actions that are (a) owned by owncloud, (b) created by GitHub (actions/*), or (c) verified in the GitHub Marketplace.

Security

Do not open a public GitHub issue for security vulnerabilities.

Report vulnerabilities at https://security.owncloud.com -- see SECURITY.md.

Bug bounty: YesWeHack ownCloud Program

License

This project is licensed under the Apache-2.0.

About the ownCloud OSPO

The Kiteworks Open Source Program Office, operating under the ownCloud brand, launched on May 5, 2026, to steward the open source ecosystem around ownCloud's products. The OSPO ensures transparent governance, license compliance, community health, and sustainable collaboration between the open source community and Kiteworks, which acquired ownCloud in 2023.

For questions about the OSPO or licensing, contact ospo@kiteworks.com.

License status: This repository is already licensed under Apache-2.0 -- the OSPO target license. No migration is required.

About

No description or website provided.

Topics

Resources

Code of conduct

Contributing

Security policy

Stars

4 stars

Watchers

12 watching

Forks

Releases

Packages

Used by

Contributors

Languages