baserCMS クラスリファレンス

Oauth2Client extends Entity
in package

Oauth2Client Entity

Table of Contents

Properties

$client_id  : string
$client_secret  : string|null
$created  : DateTime|null
$grants  : array<string|int, mixed>
$id  : int
$is_confidential  : bool
$modified  : DateTime|null
$name  : string
$redirect_uris  : array<string|int, mixed>
$registration_access_token  : string|null
$scopes  : array<string|int, mixed>
$_accessible  : array<string, bool>
accessible properties
$_hidden  : array<string|int, string>
hidden properties
$_jsonFields  : array<string|int, string>
json fields

Methods

getClientIdIssuedAt()  : int|null
getClientSecretExpiresAt()  : int|null
getClientUri()  : string|null
getContacts()  : array<string|int, mixed>
getGrants()  : array<string|int, mixed>
getIdentifier()  : string
getLogoUri()  : string|null
getName()  : string
getPolicyUri()  : string|null
getRedirectUri()  : array<string|int, mixed>
getRegistrationAccessToken()  : string|null
getRegistrationClientUri()  : string|null
getScopes()  : array<string|int, mixed>
getSecret()  : string|null
getSoftwareId()  : string|null
getSoftwareVersion()  : string|null
getTokenEndpointAuthMethod()  : string|null
getTosUri()  : string|null
toRegistrationResponse()  : array<string|int, mixed>
Dynamic Client Registration response payload(RFC 7591)

Properties

$redirect_uris

public array<string|int, mixed> $redirect_uris

$registration_access_token

public string|null $registration_access_token

$_accessible

accessible properties

protected array<string, bool> $_accessible = ['client_id' => true, 'client_secret' => true, 'name' => true, 'redirect_uris' => true, 'grants' => true, 'scopes' => true, 'is_confidential' => true, 'registration_access_token' => true, 'created' => true, 'modified' => true]

$_hidden

hidden properties

protected array<string|int, string> $_hidden = ['client_secret', 'registration_access_token']

$_jsonFields

json fields

protected array<string|int, string> $_jsonFields = ['redirect_uris', 'grants', 'scopes']

Methods

getClientIdIssuedAt()

public getClientIdIssuedAt() : int|null
Return values
int|null

getClientSecretExpiresAt()

public getClientSecretExpiresAt() : int|null
Return values
int|null

getClientUri()

public getClientUri() : string|null
Return values
string|null

getContacts()

public getContacts() : array<string|int, mixed>
Return values
array<string|int, mixed>

getGrants()

public getGrants() : array<string|int, mixed>
Return values
array<string|int, mixed>

getIdentifier()

public getIdentifier() : string
Return values
string

getLogoUri()

public getLogoUri() : string|null
Return values
string|null

getName()

public getName() : string
Return values
string

getPolicyUri()

public getPolicyUri() : string|null
Return values
string|null

getRedirectUri()

public getRedirectUri() : array<string|int, mixed>
Return values
array<string|int, mixed>

getRegistrationAccessToken()

public getRegistrationAccessToken() : string|null
Return values
string|null

getRegistrationClientUri()

public getRegistrationClientUri() : string|null
Return values
string|null

getScopes()

public getScopes() : array<string|int, mixed>
Return values
array<string|int, mixed>

getSecret()

public getSecret() : string|null
Return values
string|null

getSoftwareId()

public getSoftwareId() : string|null
Return values
string|null

getSoftwareVersion()

public getSoftwareVersion() : string|null
Return values
string|null

getTokenEndpointAuthMethod()

public getTokenEndpointAuthMethod() : string|null
Return values
string|null

getTosUri()

public getTosUri() : string|null
Return values
string|null

toRegistrationResponse()

Dynamic Client Registration response payload(RFC 7591)

public toRegistrationResponse() : array<string|int, mixed>

メモ:

  • client_secret は「登録時のみ」返すのが原則(再取得・更新時は返さない)。
  • client_secret_expires_at は有効期限がない場合 0 を返す実装もあるが、本実装では未設定時は省略。
  • token_endpoint_auth_method は is_confidential に応じて既定値を補完(true=client_secret_basic / false=none)。
  • 以下の項目は任意(クライアントメタデータ)。提供された場合のみ反映する: contacts, client_uri, logo_uri, tos_uri, policy_uri, software_id, software_version
Return values
array<string|int, mixed>
On this page

Search results