PHPackages                             codeauth/codeauth-sdk - 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. [Authentication &amp; Authorization](/categories/authentication)
4. /
5. codeauth/codeauth-sdk

ActiveLibrary[Authentication &amp; Authorization](/categories/authentication)

codeauth/codeauth-sdk
=====================

Official CodeAuth PHP SDK

v1.2.0(4mo ago)07MITPHPPHP &gt;=5.6.0

Since Nov 23Pushed 4mo agoCompare

[ Source](https://github.com/codeauth2/CodeAuth-PHP-SDK)[ Packagist](https://packagist.org/packages/codeauth/codeauth-sdk)[ Docs](https://codeauth.com/)[ RSS](/packages/codeauth-codeauth-sdk/feed)WikiDiscussions main Synced 1mo ago

READMEChangelog (1)DependenciesVersions (7)Used By (0)

CodeAuth PHP SDK
================

[](#codeauth-php-sdk)

[![Latest Stable Version](https://camo.githubusercontent.com/d940d71b37a3f415fce73153cdc2b9e8a274a23e6986267045095a89970e46f8/68747470733a2f2f706f7365722e707567782e6f72672f636f6465617574682f636f6465617574682d73646b2f762f737461626c652e737667)](https://packagist.org/packages/codeauth/codeauth-sdk)[![Total Downloads](https://camo.githubusercontent.com/853feb7f7f15287aa8b66917141bdde8b36a8ff5009e18f6b05cd0229f08e7ba/68747470733a2f2f706f7365722e707567782e6f72672f636f6465617574682f636f6465617574682d73646b2f646f776e6c6f6164732e737667)](https://packagist.org/packages/codeauth/codeauth-sdk)[![License](https://camo.githubusercontent.com/88643e6c921d2d5c05c0f470cb85976b27a8ba2a9861f54b0e48f3beec6fb7d7/68747470733a2f2f706f7365722e707567782e6f72672f636f6465617574682f636f6465617574682d73646b2f6c6963656e73652e737667)](https://packagist.org/packages/codeauth/codeauth-sdk)

Offical CodeAuth SDK. For more info, check the docs on our [official website](https://docs.codeauth.com).

Install
-------

[](#install)

You can install the bindings via [Composer](http://getcomposer.org/). Run the following command:

```
composer require codeauth/codeauth-sdk

```

To use the bindings, use Composer's [autoload](https://getcomposer.org/doc/01-basic-usage.md#autoloading):

```
require_once 'vendor/autoload.php';

```

Basic Usage
-----------

[](#basic-usage)

### Initialize CodeAuth SDK

[](#initialize-codeauth-sdk)

```
use CodeAuth\CodeAuth;
CodeAuth::Initialize("", "");
```

### Signin / Email

[](#signin--email)

Begins the sign in or register flow by sending the user a one time code via email.

```
$result = CodeAuth::SignInEmail("");
switch ($result["error"])
{
	case "bad_json": print("bad_json"); break;
	case "project_not_found": print("project_not_found"); break;
	case "bad_ip_address": print("bad_ip_address"); break;
	case "rate_limit_reached": print("rate_limit_reached"); break;
	case "bad_email": print("bad_email"); break;
	case "code_request_interval_reached": print("code_request_interval_reached"); break;
	case "code_hourly_limit_reached": print("code_hourly_limit_reached"); break;
	case "email_provider_error": print("email_provider_error"); break;
	case "internal_error": print("internal_error"); break;
	case "connection_error": print("connection_error"); break; //sdk failed to connect to api server
}
```

### Signin / Email Verify

[](#signin--email-verify)

Checks if the one time code matches in order to create a session token.

```
$result = CodeAuth::SignInEmailVerify("", "");
switch ($result["error"])
{
	case "bad_json": print("bad_json"); break;
	case "project_not_found": print("project_not_found"); break;
	case "bad_ip_address": print("bad_ip_address"); break;
	case "rate_limit_reached": print("rate_limit_reached"); break;
	case "bad_email": print("bad_email"); break;
	case "bad_code": print("bad_code"); break;
	case "internal_error": print("internal_error"); break;
	case "connection_error": print("connection_error"); break; //sdk failed to connect to api server
}
print($result["session_token"]);
print($result["email"]);
print($result["expiration"]);
print($result["refresh_left"]);
```

### Signin / Social

[](#signin--social)

Begins the sign in or register flow by allowing users to sign in through a social OAuth2 link.

```
$result = CodeAuth::SignInSocial("");
switch ($result["error"])
{
	case "bad_json": print("bad_json"); break;
	case "project_not_found": print("project_not_found"); break;
	case "bad_ip_address": print("bad_ip_address"); break;
	case "rate_limit_reached": print("rate_limit_reached"); break;
	case "bad_social_type": print("bad_social_type"); break;
	case "internal_error": print("internal_error"); break;
	case "connection_error": print("connection_error"); break; //sdk failed to connect to api server
}
print($result["signin_url"]);
```

### Signin / Social Verify

[](#signin--social-verify)

This is the next step after the user signs in with their social account. This request checks the authorization code given by the social media company in order to create a session token.

```
$result = CodeAuth::SignInSocialVerify("", "");
switch ($result["error"])
{
	case "bad_json": print("bad_json"); break;
	case "project_not_found": print("project_not_found"); break;
	case "bad_ip_address": print("bad_ip_address"); break;
	case "rate_limit_reached": print("rate_limit_reached"); break;
	case "bad_social_type": print("bad_social_type"); break;
	case "bad_authorization_code": print("bad_code"); break;
	case "internal_error": print("internal_error"); break;
	case "connection_error": print("connection_error"); break; //sdk failed to connect to api server
}
print($result["session_token"]);
print($result["email"]);
print($result["expiration"]);
print($result["refresh_left"]);
```

### Session / Info

[](#session--info)

Gets the information associated with a session token.

```
$result = CodeAuth::SessionInfo("");
switch ($result["error"])
{
	case "bad_json": print("bad_json"); break;
	case "project_not_found": print("project_not_found"); break;
	case "bad_ip_address": print("bad_ip_address"); break;
	case "rate_limit_reached": print("rate_limit_reached"); break;
	case "bad_session_token": print("bad_session_token"); break;
	case "internal_error": print("internal_error"); break;
	case "connection_error": print("connection_error"); break; //sdk failed to connect to api server
}
print($result["email"]);
print($result["expiration"]);
print($result["refresh_left"]);
```

### Session / Refresh

[](#session--refresh)

Create a new session token using existing session token.

```
$result = CodeAuth::SessionRefresh("");
switch ($result["error"])
{
	case "bad_json": print("bad_json"); break;
	case "project_not_found": print("project_not_found"); break;
	case "bad_ip_address": print("bad_ip_address"); break;
	case "rate_limit_reached": print("rate_limit_reached"); break;
	case "bad_session_token": print("bad_session_token"); break;
	case "out_of_refresh": print("out_of_refresh"); break;
	case "internal_error": print("internal_error"); break;
	case "connection_error": print("connection_error"); break;//sdk failed to connect to api server
}
print($result["session_token"]);
print($result["email"]);
print($result["expiration"]);
print($result["refresh_left"]);
```

### Session / Invalidate

[](#session--invalidate)

Invalidate a session token. By doing so, the session token can no longer be used for any api call.

```
$result = CodeAuth::SessionInvalidate("", "");
switch ($result["error"])
{
	case "bad_json": print("bad_json"); break;
	case "project_not_found": print("project_not_found"); break;
	case "bad_ip_address": print("bad_ip_address"); break;
	case "rate_limit_reached": print("rate_limit_reached"); break;
	case "bad_session_token": print("bad_session_token"); break;
	case "bad_invalidate_type": print("bad_invalidate_type"); break;
	case "internal_error": print("internal_error"); break;
	case "connection_error": print("connection_error"); break; //sdk failed to connect to api server
}
```

###  Health Score

32

—

LowBetter than 71% of packages

Maintenance80

Actively maintained with recent releases

Popularity4

Limited adoption so far

Community6

Small or concentrated contributor base

Maturity34

Early-stage or recently created project

 Bus Factor1

Top contributor holds 100% of commits — single point of failure

How is this calculated?**Maintenance (25%)** — Last commit recency, latest release date, and issue-to-star ratio. Uses a 2-year decay window.

**Popularity (30%)** — Total and monthly downloads, GitHub stars, and forks. Logarithmic scaling prevents top-heavy scores.

**Community (15%)** — Contributors, dependents, forks, watchers, and maintainers. Measures real ecosystem engagement.

**Maturity (30%)** — Project age, version count, PHP version support, and release stability.

###  Release Activity

Cadence

Every ~6 days

Total

6

Last Release

135d ago

PHP version history (2 changes)v1.0.0PHP &gt;=7.4

v1.0.2PHP &gt;=5.6.0

### Community

Maintainers

![](https://www.gravatar.com/avatar/1718a8add6fabf2552c7859d252f70935ee026ba842874036936972bafbd16db?d=identicon)[codeauth2](/maintainers/codeauth2)

---

Top Contributors

[![codeauth2](https://avatars.githubusercontent.com/u/245720107?v=4)](https://github.com/codeauth2 "codeauth2 (26 commits)")

---

Tags

apiauthAuthenticationcodeauth

### Embed Badge

![Health badge](/badges/codeauth-codeauth-sdk/health.svg)

```
[![Health](https://phpackages.com/badges/codeauth-codeauth-sdk/health.svg)](https://phpackages.com/packages/codeauth-codeauth-sdk)
```

###  Alternatives

[league/oauth2-server

A lightweight and powerful OAuth 2.0 authorization and resource server library with support for all the core specification grants. This library will allow you to secure your API with OAuth and allow your applications users to approve apps that want to access their data from your API.

6.6k136.0M247](/packages/league-oauth2-server)[auth0/auth0-php

PHP SDK for Auth0 Authentication and Management APIs.

40820.2M67](/packages/auth0-auth0-php)[auth0/login

Auth0 Laravel SDK. Straight-forward and tested methods for implementing authentication, and accessing Auth0's Management API endpoints.

2745.0M3](/packages/auth0-login)[auth0/symfony

Symfony SDK for Auth0 Authentication and Management APIs.

128738.1k](/packages/auth0-symfony)[auth0/wordpress

WordPress Plugin for Auth0

17419.5k](/packages/auth0-wordpress)

PHPackages © 2026

[Directory](/)[Categories](/categories)[Trending](/trending)[Changelog](/changelog)[Analyze](/analyze)
