PHPackages                             onelogin/api - PHPackages - PHPackages  [Skip to content](#main-content)[PHPackages](/)[Directory](/)[Categories](/categories)[Trending](/trending)[Leaderboard](/leaderboard)[Changelog](/changelog)[Analyze](/analyze)[Collections](/collections)[Log in](/login)[Sign up](/register)

1. [Directory](/)
2. /
3. [API Development](/categories/api)
4. /
5. onelogin/api

ActiveLibrary[API Development](/categories/api)

onelogin/api
============

1.8.2(3w ago)1242.4k↓20.6%181MITPHPPHP >=8.1CI failing

Since Oct 20Pushed 3w ago34 watchersCompare

[ Source](https://github.com/onelogin/onelogin-php-sdk)[ Packagist](https://packagist.org/packages/onelogin/api)[ RSS](/packages/onelogin-api/feed)WikiDiscussions master Synced yesterday

READMEChangelog (10)Dependencies (4)Versions (18)Used By (1)

OneLogin PHP SDK
================

[](#onelogin-php-sdk)

This SDK will let you execute all the API methods, version/1, described at .

Support
-------

[](#support)

OneLogin by One Identity open source projects are supported through [OneLogin GitHub issues](https://github.com/onelogin/onelogin-php-sdk/issues). This includes all scripts, plugins, SDKs, modules, code snippets or other solutions. For assistance with any OneLogin by One Identity GitHub project, please raise a new Issue on the [OneLogin GitHub issues](https://github.com/onelogin/onelogin-php-sdk/issues) page. Requests for assistance made through official One Identity Support will be referred back to GitHub where those requests can benefit all users.

Installation
------------

[](#installation)

### Hosting

[](#hosting)

#### Github

[](#github)

The toolkit is hosted on github. You can download it from:

- Lastest release:
- Master repo:

#### Composer

[](#composer)

The toolkit supports [composer](https://getcomposer.org/). You can find the `onelogin/api` package at

In order to import the sdk into your current php project, execute

```
composer require onelogin/api

```

### Dependencies

[](#dependencies)

See [`composer.json`](composer.json) for the authoritative list of required PHP and library versions. At a high level the SDK requires a supported PHP version and the [Guzzle](https://docs.guzzlephp.org/) HTTP client; Composer resolves the exact compatible versions for your project automatically.

Getting started
---------------

[](#getting-started)

> **Changelog:** Release notes and the changes in each version are published on the [Releases page](https://github.com/onelogin/onelogin-php-sdk/releases).

The SDK supports two interchangeable, fully backward-compatible approaches to error handling: exception-based handling and traditional manual error checking. Both are described under [Errors and exceptions](#errors-and-exceptions) below.

You'll need a OneLogin account and a set of API credentials before you get started.

If you don't have an account you can [sign up for a free developer account here](https://www.onelogin.com/developer-signup).

client\_idRequired: A valid OneLogin API client\_idclient\_secretRequired: A valid OneLogin API client\_secretregionOptional: `us` or `eu`. Defaults to `us````