README

Auth Service の PHP SDK です。OpenAPI 仕様から自動生成されています。

要件

• PHP 8.2 以上
• PHP 拡張: curl, json, mbstring

インストール

安定版

composer require studio-design/studio-auth-php

Snapshot 版（リリース前検証用）

main にマージされた未リリースの SDK 変更を staging で検証する用途で、Composer の prerelease 制約で snapshot タグを取得できます。

composer require "studio-design/studio-auth-php:^X.Y.Z@rc"

X.Y.Z は次回リリース予定のバージョン（直近 stable パッチ + 1）です。最新の snapshot タグは studio-auth-php の Releases を参照してください。

⚠️ snapshot 版は staging / CI 検証用です。本番デプロイには安定版（composer require studio-design/studio-auth-php または :^X.Y.Z）を使用してください。

使い方

ホスト設定（必須）

SDK にはデフォルトのホスト URL が設定されていません。利用前に必ず setHost() で接続先を指定してください。

$config = Studio\Auth\Configuration::getDefaultConfiguration()
    ->setHost('https://your-auth-server.example.com');

AdminApi（BearerAuth）— 組織一覧取得

Admin 系のエンドポイントは Bearer トークン（JWT）で認証します。

<?php
require_once __DIR__ . '/vendor/autoload.php';

$config = Studio\Auth\Configuration::getDefaultConfiguration()
    ->setHost('https://your-auth-server.example.com')
    ->setAccessToken('YOUR_ACCESS_TOKEN');

$adminApi = new Studio\Auth\Api\AdminApi(
    new GuzzleHttp\Client(),
    $config,
);

try {
    $result = $adminApi->listOrganizations();
    print_r($result);
} catch (Studio\Auth\ApiException $e) {
    echo 'Exception: ', $e->getMessage(), PHP_EOL;
}

AuthApi（ClientBasicAuth）— トークンイントロスペクション

OAuth 2.0 のトークンエンドポイントやイントロスペクションは HTTP Basic 認証（client_id / client_secret）で認証します。

<?php
require_once __DIR__ . '/vendor/autoload.php';

$config = Studio\Auth\Configuration::getDefaultConfiguration()
    ->setHost('https://your-auth-server.example.com')
    ->setUsername('YOUR_CLIENT_ID')
    ->setPassword('YOUR_CLIENT_SECRET');

$authApi = new Studio\Auth\Api\AuthApi(
    new GuzzleHttp\Client(),
    $config,
);

try {
    $result = $authApi->introspectToken('YOUR_TOKEN');
    print_r($result);
} catch (Studio\Auth\ApiException $e) {
    echo 'Exception: ', $e->getMessage(), PHP_EOL;
}

API エンドポイント一覧

モデル一覧

• AdminClientCreateRequest
• AdminClientCreatedResponse
• AdminClientListResponse
• AdminClientUpdateRequest
• AdminOrganizationCreateRequest
• AdminOrganizationCreatedResponse
• AdminOrganizationInvitationCreateRequest
• AdminOrganizationInvitationCreatedResponse
• AdminOrganizationInvitationListResponse
• AdminOrganizationListResponse
• AdminOrganizationMemberListResponse
• AdminOrganizationMemberUpdateRequest
• AdminOrganizationUpdateRequest
• AdminPortalSessionCreateRequest
• AdminPortalSessionCreatedResponse
• CheckSsoEnforcementResponse
• Client
• CodeChallengeMethod
• EcJsonWebKey
• GrantType
• HealthStatus
• IdpAuthorizeErrorCode
• InlineObject
• InlineObject1
• IntrospectErrorCode
• IntrospectErrorResponse
• IntrospectResponse
• IntrospectResponseAud
• JsonWebKey
• JwksResponse
• MemberDomainTypeCounts
• MemberRoleCounts
• MyOrganization
• OauthAuthorizeErrorCode
• OidcAuthorizeErrorCode
• OpenIDProviderMetadataResponse
• Organization
• OrganizationInvitation
• OrganizationInvitationCreateRequest
• OrganizationInvitationCreatedResponse
• OrganizationMember
• OrganizationMemberDomainType
• OrganizationMemberListResponse
• OrganizationMemberUpdateRequest
• OrganizationMemberUser
• OrganizationRole
• OrganizationUpdateRequest
• PaginationMeta
• ProblemDetails
• Prompt
• ResponseType
• RevokeErrorCode
• RevokeErrorResponse
• RsaJsonWebKey
• ServiceInfoResponse
• SsoEnforcementErrorResponse
• TokenErrorCode
• TokenErrorResponse
• TokenResponse
• TokenType
• TokenTypeHint
• UserinfoResponse

認証方式

BearerAuth

• 種別: Bearer 認証（JWT）
• 対象: AdminApi の全エンドポイント、AuthApi の userinfo エンドポイント
• 設定: $config->setAccessToken('YOUR_ACCESS_TOKEN')

ClientBasicAuth

• 種別: HTTP Basic 認証
• 対象: AuthApi の token / introspect / revoke エンドポイント
• 設定: $config->setUsername('CLIENT_ID')->setPassword('CLIENT_SECRET')

ライセンス

MIT License - LICENSE を参照してください。

このパッケージは Studio Auth Service の OpenAPI 仕様 から自動生成されています（SDK バージョン: 0.3.1）。