forge-dashboard-sdk-php

AuthApi
in package

ForgeDashboard

Generated

AuthApi Class Doc Comment

Constants

contentTypes : array<string|int, string> = ['beginAddCredential' => ['application/json'],...

Properties

$client : ClientInterface
$config : Configuration
$headerSelector : HeaderSelector
$hostIndex : int

Methods

__construct() : mixed
beginAddCredential() : array<string, mixed>|Error: Operation beginAddCredential
beginAddCredentialAsync() : PromiseInterface: Operation beginAddCredentialAsync
beginAddCredentialAsyncWithHttpInfo() : PromiseInterface: Operation beginAddCredentialAsyncWithHttpInfo
beginAddCredentialRequest() : Request: Create request for operation 'beginAddCredential'
beginAddCredentialWithHttpInfo() : array<string|int, mixed>: Operation beginAddCredentialWithHttpInfo
beginLogin() : array<string, mixed>|Error: Operation beginLogin
beginLoginAsync() : PromiseInterface: Operation beginLoginAsync
beginLoginAsyncWithHttpInfo() : PromiseInterface: Operation beginLoginAsyncWithHttpInfo
beginLoginRequest() : Request: Create request for operation 'beginLogin'
beginLoginWithHttpInfo() : array<string|int, mixed>: Operation beginLoginWithHttpInfo
beginRegistration() : array<string, mixed>|Error: Operation beginRegistration
beginRegistrationAsync() : PromiseInterface: Operation beginRegistrationAsync
beginRegistrationAsyncWithHttpInfo() : PromiseInterface: Operation beginRegistrationAsyncWithHttpInfo
beginRegistrationRequest() : Request: Create request for operation 'beginRegistration'
beginRegistrationWithHttpInfo() : array<string|int, mixed>: Operation beginRegistrationWithHttpInfo
deleteCredential() : void: Operation deleteCredential
deleteCredentialAsync() : PromiseInterface: Operation deleteCredentialAsync
deleteCredentialAsyncWithHttpInfo() : PromiseInterface: Operation deleteCredentialAsyncWithHttpInfo
deleteCredentialRequest() : Request: Create request for operation 'deleteCredential'
deleteCredentialWithHttpInfo() : array<string|int, mixed>: Operation deleteCredentialWithHttpInfo
finishAddCredential() : Credential|Error: Operation finishAddCredential
finishAddCredentialAsync() : PromiseInterface: Operation finishAddCredentialAsync
finishAddCredentialAsyncWithHttpInfo() : PromiseInterface: Operation finishAddCredentialAsyncWithHttpInfo
finishAddCredentialRequest() : Request: Create request for operation 'finishAddCredential'
finishAddCredentialWithHttpInfo() : array<string|int, mixed>: Operation finishAddCredentialWithHttpInfo
finishLogin() : SessionUser|Error: Operation finishLogin
finishLoginAsync() : PromiseInterface: Operation finishLoginAsync
finishLoginAsyncWithHttpInfo() : PromiseInterface: Operation finishLoginAsyncWithHttpInfo
finishLoginRequest() : Request: Create request for operation 'finishLogin'
finishLoginWithHttpInfo() : array<string|int, mixed>: Operation finishLoginWithHttpInfo
finishRegistration() : SessionUser|Error: Operation finishRegistration
finishRegistrationAsync() : PromiseInterface: Operation finishRegistrationAsync
finishRegistrationAsyncWithHttpInfo() : PromiseInterface: Operation finishRegistrationAsyncWithHttpInfo
finishRegistrationRequest() : Request: Create request for operation 'finishRegistration'
finishRegistrationWithHttpInfo() : array<string|int, mixed>: Operation finishRegistrationWithHttpInfo
getConfig() : Configuration
getHostIndex() : int: Get the host index
getRegistrationStatus() : RegistrationStatus: Operation getRegistrationStatus
getRegistrationStatusAsync() : PromiseInterface: Operation getRegistrationStatusAsync
getRegistrationStatusAsyncWithHttpInfo() : PromiseInterface: Operation getRegistrationStatusAsyncWithHttpInfo
getRegistrationStatusRequest() : Request: Create request for operation 'getRegistrationStatus'
getRegistrationStatusWithHttpInfo() : array<string|int, mixed>: Operation getRegistrationStatusWithHttpInfo
getSession() : SessionUser|Error: Operation getSession
getSessionAsync() : PromiseInterface: Operation getSessionAsync
getSessionAsyncWithHttpInfo() : PromiseInterface: Operation getSessionAsyncWithHttpInfo
getSessionRequest() : Request: Create request for operation 'getSession'
getSessionWithHttpInfo() : array<string|int, mixed>: Operation getSessionWithHttpInfo
listCredentials() : array<string|int, Credential>|Error: Operation listCredentials
listCredentialsAsync() : PromiseInterface: Operation listCredentialsAsync
listCredentialsAsyncWithHttpInfo() : PromiseInterface: Operation listCredentialsAsyncWithHttpInfo
listCredentialsRequest() : Request: Create request for operation 'listCredentials'
listCredentialsWithHttpInfo() : array<string|int, mixed>: Operation listCredentialsWithHttpInfo
logout() : void: Operation logout
logoutAsync() : PromiseInterface: Operation logoutAsync
logoutAsyncWithHttpInfo() : PromiseInterface: Operation logoutAsyncWithHttpInfo
logoutRequest() : Request: Create request for operation 'logout'
logoutWithHttpInfo() : array<string|int, mixed>: Operation logoutWithHttpInfo
setHostIndex() : void: Set the host index
createHttpClientOption() : array<string|int, mixed>: Create http client option
handleResponseWithDataType() : array<string|int, mixed>
responseWithinRangeCode() : bool

contentTypes


    public
        array<string|int, string>
    contentTypes
    = ['beginAddCredential' => ['application/json'], 'beginLogin' => ['application/json'], 'beginRegistration' => ['application/json'], 'deleteCredential' => ['application/json'], 'finishAddCredential' => ['application/json'], 'finishLogin' => ['application/json'], 'finishRegistration' => ['application/json'], 'getRegistrationStatus' => ['application/json'], 'getSession' => ['application/json'], 'listCredentials' => ['application/json'], 'logout' => ['application/json']]

$client


        protected
            ClientInterface
    $client

$config


        protected
            Configuration
    $config

$headerSelector


        protected
            HeaderSelector
    $headerSelector

$hostIndex


        protected
            int
    $hostIndex

Host index

__construct()


    public
                    __construct([ClientInterface $client = null ][, Configuration $config = null ][, HeaderSelector $selector = null ][, int $hostIndex = 0 ]) : mixed

Parameters

$client : ClientInterface = null
$config : Configuration = null
$selector : HeaderSelector = null
$hostIndex : int = 0: (Optional) host index to select the list of hosts if defined in the OpenAPI spec

beginAddCredential()

Operation beginAddCredential


    public
                    beginAddCredential([string $contentType = self::contentTypes['beginAddCredential'][0] ]) : array<string, mixed>|Error

Start a ceremony to add another passkey to the signed-in account

Parameters

$contentType : string = self::contentTypes['beginAddCredential'][0]: The value for the Content-Type header. Check self::contentTypes['beginAddCredential'] to see the possible values for this operation

Return values

array<string, mixed>|Error

beginAddCredentialAsync()

Operation beginAddCredentialAsync


    public
                    beginAddCredentialAsync([string $contentType = self::contentTypes['beginAddCredential'][0] ]) : PromiseInterface

Start a ceremony to add another passkey to the signed-in account

Parameters

$contentType : string = self::contentTypes['beginAddCredential'][0]: The value for the Content-Type header. Check self::contentTypes['beginAddCredential'] to see the possible values for this operation

Return values

PromiseInterface

beginAddCredentialAsyncWithHttpInfo()

Operation beginAddCredentialAsyncWithHttpInfo


    public
                    beginAddCredentialAsyncWithHttpInfo([string $contentType = self::contentTypes['beginAddCredential'][0] ]) : PromiseInterface

Start a ceremony to add another passkey to the signed-in account

Parameters

$contentType : string = self::contentTypes['beginAddCredential'][0]: The value for the Content-Type header. Check self::contentTypes['beginAddCredential'] to see the possible values for this operation

Return values

PromiseInterface

beginAddCredentialRequest()

Create request for operation 'beginAddCredential'


    public
                    beginAddCredentialRequest([string $contentType = self::contentTypes['beginAddCredential'][0] ]) : Request

Parameters

$contentType : string = self::contentTypes['beginAddCredential'][0]: The value for the Content-Type header. Check self::contentTypes['beginAddCredential'] to see the possible values for this operation

Return values

Request

beginAddCredentialWithHttpInfo()

Operation beginAddCredentialWithHttpInfo


    public
                    beginAddCredentialWithHttpInfo([string $contentType = self::contentTypes['beginAddCredential'][0] ]) : array<string|int, mixed>

Start a ceremony to add another passkey to the signed-in account

Parameters

$contentType : string = self::contentTypes['beginAddCredential'][0]: The value for the Content-Type header. Check self::contentTypes['beginAddCredential'] to see the possible values for this operation

Return values

array<string|int, mixed> —

of array<string,mixed>|\ForgeDashboard\Generated\Model\Error, HTTP status code, HTTP response headers (array of strings)

beginLogin()

Operation beginLogin


    public
                    beginLogin(LoginBeginRequest $login_begin_request[, string $contentType = self::contentTypes['beginLogin'][0] ]) : array<string, mixed>|Error

Start a passkey login ceremony

Parameters

$login_begin_request : LoginBeginRequest: login_begin_request (required)
$contentType : string = self::contentTypes['beginLogin'][0]: The value for the Content-Type header. Check self::contentTypes['beginLogin'] to see the possible values for this operation

Return values

array<string, mixed>|Error

beginLoginAsync()

Operation beginLoginAsync


    public
                    beginLoginAsync(LoginBeginRequest $login_begin_request[, string $contentType = self::contentTypes['beginLogin'][0] ]) : PromiseInterface

Start a passkey login ceremony

Parameters

$login_begin_request : LoginBeginRequest: (required)
$contentType : string = self::contentTypes['beginLogin'][0]: The value for the Content-Type header. Check self::contentTypes['beginLogin'] to see the possible values for this operation

Return values

PromiseInterface

beginLoginAsyncWithHttpInfo()

Operation beginLoginAsyncWithHttpInfo


    public
                    beginLoginAsyncWithHttpInfo(LoginBeginRequest $login_begin_request[, string $contentType = self::contentTypes['beginLogin'][0] ]) : PromiseInterface

Start a passkey login ceremony

Parameters

$login_begin_request : LoginBeginRequest: (required)
$contentType : string = self::contentTypes['beginLogin'][0]: The value for the Content-Type header. Check self::contentTypes['beginLogin'] to see the possible values for this operation

Return values

PromiseInterface

beginLoginRequest()

Create request for operation 'beginLogin'


    public
                    beginLoginRequest(LoginBeginRequest $login_begin_request[, string $contentType = self::contentTypes['beginLogin'][0] ]) : Request

Parameters

$login_begin_request : LoginBeginRequest: (required)
$contentType : string = self::contentTypes['beginLogin'][0]: The value for the Content-Type header. Check self::contentTypes['beginLogin'] to see the possible values for this operation

Return values

Request

beginLoginWithHttpInfo()

Operation beginLoginWithHttpInfo


    public
                    beginLoginWithHttpInfo(LoginBeginRequest $login_begin_request[, string $contentType = self::contentTypes['beginLogin'][0] ]) : array<string|int, mixed>

Start a passkey login ceremony

Parameters

$login_begin_request : LoginBeginRequest: (required)
$contentType : string = self::contentTypes['beginLogin'][0]: The value for the Content-Type header. Check self::contentTypes['beginLogin'] to see the possible values for this operation

Return values

array<string|int, mixed> —

of array<string,mixed>|\ForgeDashboard\Generated\Model\Error, HTTP status code, HTTP response headers (array of strings)

beginRegistration()

Operation beginRegistration


    public
                    beginRegistration(RegisterBeginRequest $register_begin_request[, string $contentType = self::contentTypes['beginRegistration'][0] ]) : array<string, mixed>|Error

Start a passkey registration ceremony

Parameters

$register_begin_request : RegisterBeginRequest: register_begin_request (required)
$contentType : string = self::contentTypes['beginRegistration'][0]: The value for the Content-Type header. Check self::contentTypes['beginRegistration'] to see the possible values for this operation

Return values

array<string, mixed>|Error

beginRegistrationAsync()

Operation beginRegistrationAsync


    public
                    beginRegistrationAsync(RegisterBeginRequest $register_begin_request[, string $contentType = self::contentTypes['beginRegistration'][0] ]) : PromiseInterface

Start a passkey registration ceremony

Parameters

$register_begin_request : RegisterBeginRequest: (required)
$contentType : string = self::contentTypes['beginRegistration'][0]: The value for the Content-Type header. Check self::contentTypes['beginRegistration'] to see the possible values for this operation

Return values

PromiseInterface

beginRegistrationAsyncWithHttpInfo()

Operation beginRegistrationAsyncWithHttpInfo


    public
                    beginRegistrationAsyncWithHttpInfo(RegisterBeginRequest $register_begin_request[, string $contentType = self::contentTypes['beginRegistration'][0] ]) : PromiseInterface

Start a passkey registration ceremony

Parameters

$register_begin_request : RegisterBeginRequest: (required)
$contentType : string = self::contentTypes['beginRegistration'][0]: The value for the Content-Type header. Check self::contentTypes['beginRegistration'] to see the possible values for this operation

Return values

PromiseInterface

beginRegistrationRequest()

Create request for operation 'beginRegistration'


    public
                    beginRegistrationRequest(RegisterBeginRequest $register_begin_request[, string $contentType = self::contentTypes['beginRegistration'][0] ]) : Request

Parameters

$register_begin_request : RegisterBeginRequest: (required)
$contentType : string = self::contentTypes['beginRegistration'][0]: The value for the Content-Type header. Check self::contentTypes['beginRegistration'] to see the possible values for this operation

Return values

Request

beginRegistrationWithHttpInfo()

Operation beginRegistrationWithHttpInfo


    public
                    beginRegistrationWithHttpInfo(RegisterBeginRequest $register_begin_request[, string $contentType = self::contentTypes['beginRegistration'][0] ]) : array<string|int, mixed>

Start a passkey registration ceremony

Parameters

$register_begin_request : RegisterBeginRequest: (required)
$contentType : string = self::contentTypes['beginRegistration'][0]: The value for the Content-Type header. Check self::contentTypes['beginRegistration'] to see the possible values for this operation

Return values

array<string|int, mixed> —

of array<string,mixed>|\ForgeDashboard\Generated\Model\Error|\ForgeDashboard\Generated\Model\Error, HTTP status code, HTTP response headers (array of strings)

deleteCredential()

Operation deleteCredential


    public
                    deleteCredential(string $id[, string $contentType = self::contentTypes['deleteCredential'][0] ]) : void

Remove one of the signed-in user's own passkeys

Parameters

$id : string: id (required)
$contentType : string = self::contentTypes['deleteCredential'][0]: The value for the Content-Type header. Check self::contentTypes['deleteCredential'] to see the possible values for this operation

deleteCredentialAsync()

Operation deleteCredentialAsync


    public
                    deleteCredentialAsync(string $id[, string $contentType = self::contentTypes['deleteCredential'][0] ]) : PromiseInterface

Remove one of the signed-in user's own passkeys

Parameters

$id : string: (required)
$contentType : string = self::contentTypes['deleteCredential'][0]: The value for the Content-Type header. Check self::contentTypes['deleteCredential'] to see the possible values for this operation

Return values

PromiseInterface

deleteCredentialAsyncWithHttpInfo()

Operation deleteCredentialAsyncWithHttpInfo


    public
                    deleteCredentialAsyncWithHttpInfo(string $id[, string $contentType = self::contentTypes['deleteCredential'][0] ]) : PromiseInterface

Remove one of the signed-in user's own passkeys

Parameters

$id : string: (required)
$contentType : string = self::contentTypes['deleteCredential'][0]: The value for the Content-Type header. Check self::contentTypes['deleteCredential'] to see the possible values for this operation

Return values

PromiseInterface

deleteCredentialRequest()

Create request for operation 'deleteCredential'


    public
                    deleteCredentialRequest(string $id[, string $contentType = self::contentTypes['deleteCredential'][0] ]) : Request

Parameters

$id : string: (required)
$contentType : string = self::contentTypes['deleteCredential'][0]: The value for the Content-Type header. Check self::contentTypes['deleteCredential'] to see the possible values for this operation

Return values

Request

deleteCredentialWithHttpInfo()

Operation deleteCredentialWithHttpInfo


    public
                    deleteCredentialWithHttpInfo(string $id[, string $contentType = self::contentTypes['deleteCredential'][0] ]) : array<string|int, mixed>

Remove one of the signed-in user's own passkeys

Parameters

$id : string: (required)
$contentType : string = self::contentTypes['deleteCredential'][0]: The value for the Content-Type header. Check self::contentTypes['deleteCredential'] to see the possible values for this operation

Return values

array<string|int, mixed> —

of null, HTTP status code, HTTP response headers (array of strings)

finishAddCredential()

Operation finishAddCredential


    public
                    finishAddCredential(string $label, array<string, mixed> $request_body[, string $contentType = self::contentTypes['finishAddCredential'][0] ]) : Credential|Error

Complete an add-credential ceremony

Parameters

$label : string: A name the user recognizes, e.g. "MacBook" or "YubiKey", prompted for at registration time, never derived from the authenticator itself. (required)
$request_body : array<string, mixed>: The raw response from `navigator.credentials.create()`, exactly as the browser produced it — forwarded to the server untouched. (required)
$contentType : string = self::contentTypes['finishAddCredential'][0]: The value for the Content-Type header. Check self::contentTypes['finishAddCredential'] to see the possible values for this operation

Return values

Credential|Error

finishAddCredentialAsync()

Operation finishAddCredentialAsync


    public
                    finishAddCredentialAsync(string $label, array<string, mixed> $request_body[, string $contentType = self::contentTypes['finishAddCredential'][0] ]) : PromiseInterface

Complete an add-credential ceremony

Parameters

$label : string: A name the user recognizes, e.g. "MacBook" or "YubiKey", prompted for at registration time, never derived from the authenticator itself. (required)
$request_body : array<string, mixed>: The raw response from `navigator.credentials.create()`, exactly as the browser produced it — forwarded to the server untouched. (required)
$contentType : string = self::contentTypes['finishAddCredential'][0]: The value for the Content-Type header. Check self::contentTypes['finishAddCredential'] to see the possible values for this operation

Return values

PromiseInterface

finishAddCredentialAsyncWithHttpInfo()

Operation finishAddCredentialAsyncWithHttpInfo


    public
                    finishAddCredentialAsyncWithHttpInfo(string $label, array<string, mixed> $request_body[, string $contentType = self::contentTypes['finishAddCredential'][0] ]) : PromiseInterface

Complete an add-credential ceremony

Parameters

$label : string: A name the user recognizes, e.g. "MacBook" or "YubiKey", prompted for at registration time, never derived from the authenticator itself. (required)
$request_body : array<string, mixed>: The raw response from `navigator.credentials.create()`, exactly as the browser produced it — forwarded to the server untouched. (required)
$contentType : string = self::contentTypes['finishAddCredential'][0]: The value for the Content-Type header. Check self::contentTypes['finishAddCredential'] to see the possible values for this operation

Return values

PromiseInterface

finishAddCredentialRequest()

Create request for operation 'finishAddCredential'


    public
                    finishAddCredentialRequest(string $label, array<string, mixed> $request_body[, string $contentType = self::contentTypes['finishAddCredential'][0] ]) : Request

Parameters

$label : string: A name the user recognizes, e.g. "MacBook" or "YubiKey", prompted for at registration time, never derived from the authenticator itself. (required)
$request_body : array<string, mixed>: The raw response from `navigator.credentials.create()`, exactly as the browser produced it — forwarded to the server untouched. (required)
$contentType : string = self::contentTypes['finishAddCredential'][0]: The value for the Content-Type header. Check self::contentTypes['finishAddCredential'] to see the possible values for this operation

Return values

Request

finishAddCredentialWithHttpInfo()

Operation finishAddCredentialWithHttpInfo


    public
                    finishAddCredentialWithHttpInfo(string $label, array<string, mixed> $request_body[, string $contentType = self::contentTypes['finishAddCredential'][0] ]) : array<string|int, mixed>

Complete an add-credential ceremony

Parameters

$label : string: A name the user recognizes, e.g. "MacBook" or "YubiKey", prompted for at registration time, never derived from the authenticator itself. (required)
$request_body : array<string, mixed>: The raw response from `navigator.credentials.create()`, exactly as the browser produced it — forwarded to the server untouched. (required)
$contentType : string = self::contentTypes['finishAddCredential'][0]: The value for the Content-Type header. Check self::contentTypes['finishAddCredential'] to see the possible values for this operation

Return values

array<string|int, mixed> —

of \ForgeDashboard\Generated\Model\Credential|\ForgeDashboard\Generated\Model\Error|\ForgeDashboard\Generated\Model\Error, HTTP status code, HTTP response headers (array of strings)

finishLogin()

Operation finishLogin


    public
                    finishLogin(string $username, array<string, mixed> $request_body[, string $contentType = self::contentTypes['finishLogin'][0] ]) : SessionUser|Error

Complete a passkey login ceremony

Parameters

$username : string: username (required)
$request_body : array<string, mixed>: The raw response from `navigator.credentials.get()`, exactly as the browser produced it — forwarded to the server untouched. (required)
$contentType : string = self::contentTypes['finishLogin'][0]: The value for the Content-Type header. Check self::contentTypes['finishLogin'] to see the possible values for this operation

Return values

SessionUser|Error

finishLoginAsync()

Operation finishLoginAsync


    public
                    finishLoginAsync(string $username, array<string, mixed> $request_body[, string $contentType = self::contentTypes['finishLogin'][0] ]) : PromiseInterface

Complete a passkey login ceremony

Parameters

$username : string: (required)
$request_body : array<string, mixed>: The raw response from `navigator.credentials.get()`, exactly as the browser produced it — forwarded to the server untouched. (required)
$contentType : string = self::contentTypes['finishLogin'][0]: The value for the Content-Type header. Check self::contentTypes['finishLogin'] to see the possible values for this operation

Return values

PromiseInterface

finishLoginAsyncWithHttpInfo()

Operation finishLoginAsyncWithHttpInfo


    public
                    finishLoginAsyncWithHttpInfo(string $username, array<string, mixed> $request_body[, string $contentType = self::contentTypes['finishLogin'][0] ]) : PromiseInterface

Complete a passkey login ceremony

Parameters

$username : string: (required)
$request_body : array<string, mixed>: The raw response from `navigator.credentials.get()`, exactly as the browser produced it — forwarded to the server untouched. (required)
$contentType : string = self::contentTypes['finishLogin'][0]: The value for the Content-Type header. Check self::contentTypes['finishLogin'] to see the possible values for this operation

Return values

PromiseInterface

finishLoginRequest()

Create request for operation 'finishLogin'


    public
                    finishLoginRequest(string $username, array<string, mixed> $request_body[, string $contentType = self::contentTypes['finishLogin'][0] ]) : Request

Parameters

$username : string: (required)
$request_body : array<string, mixed>: The raw response from `navigator.credentials.get()`, exactly as the browser produced it — forwarded to the server untouched. (required)
$contentType : string = self::contentTypes['finishLogin'][0]: The value for the Content-Type header. Check self::contentTypes['finishLogin'] to see the possible values for this operation

Return values

Request

finishLoginWithHttpInfo()

Operation finishLoginWithHttpInfo


    public
                    finishLoginWithHttpInfo(string $username, array<string, mixed> $request_body[, string $contentType = self::contentTypes['finishLogin'][0] ]) : array<string|int, mixed>

Complete a passkey login ceremony

Parameters

$username : string: (required)
$request_body : array<string, mixed>: The raw response from `navigator.credentials.get()`, exactly as the browser produced it — forwarded to the server untouched. (required)
$contentType : string = self::contentTypes['finishLogin'][0]: The value for the Content-Type header. Check self::contentTypes['finishLogin'] to see the possible values for this operation

Return values

array<string|int, mixed> —

of \ForgeDashboard\Generated\Model\SessionUser|\ForgeDashboard\Generated\Model\Error, HTTP status code, HTTP response headers (array of strings)

finishRegistration()

Operation finishRegistration


    public
                    finishRegistration(string $username, array<string, mixed> $request_body[, string $contentType = self::contentTypes['finishRegistration'][0] ]) : SessionUser|Error

Complete a passkey registration ceremony

Parameters

$username : string: username (required)
$request_body : array<string, mixed>: The raw response from `navigator.credentials.create()`, exactly as the browser produced it — forwarded to the server untouched. (required)
$contentType : string = self::contentTypes['finishRegistration'][0]: The value for the Content-Type header. Check self::contentTypes['finishRegistration'] to see the possible values for this operation

Return values

SessionUser|Error

finishRegistrationAsync()

Operation finishRegistrationAsync


    public
                    finishRegistrationAsync(string $username, array<string, mixed> $request_body[, string $contentType = self::contentTypes['finishRegistration'][0] ]) : PromiseInterface

Complete a passkey registration ceremony

Parameters

$username : string: (required)
$request_body : array<string, mixed>: The raw response from `navigator.credentials.create()`, exactly as the browser produced it — forwarded to the server untouched. (required)
$contentType : string = self::contentTypes['finishRegistration'][0]: The value for the Content-Type header. Check self::contentTypes['finishRegistration'] to see the possible values for this operation

Return values

PromiseInterface

finishRegistrationAsyncWithHttpInfo()

Operation finishRegistrationAsyncWithHttpInfo


    public
                    finishRegistrationAsyncWithHttpInfo(string $username, array<string, mixed> $request_body[, string $contentType = self::contentTypes['finishRegistration'][0] ]) : PromiseInterface

Complete a passkey registration ceremony

Parameters

$username : string: (required)
$request_body : array<string, mixed>: The raw response from `navigator.credentials.create()`, exactly as the browser produced it — forwarded to the server untouched. (required)
$contentType : string = self::contentTypes['finishRegistration'][0]: The value for the Content-Type header. Check self::contentTypes['finishRegistration'] to see the possible values for this operation

Return values

PromiseInterface

finishRegistrationRequest()

Create request for operation 'finishRegistration'


    public
                    finishRegistrationRequest(string $username, array<string, mixed> $request_body[, string $contentType = self::contentTypes['finishRegistration'][0] ]) : Request

Parameters

$username : string: (required)
$request_body : array<string, mixed>: The raw response from `navigator.credentials.create()`, exactly as the browser produced it — forwarded to the server untouched. (required)
$contentType : string = self::contentTypes['finishRegistration'][0]: The value for the Content-Type header. Check self::contentTypes['finishRegistration'] to see the possible values for this operation

Return values

Request

finishRegistrationWithHttpInfo()

Operation finishRegistrationWithHttpInfo


    public
                    finishRegistrationWithHttpInfo(string $username, array<string, mixed> $request_body[, string $contentType = self::contentTypes['finishRegistration'][0] ]) : array<string|int, mixed>

Complete a passkey registration ceremony

Parameters

$username : string: (required)
$request_body : array<string, mixed>: The raw response from `navigator.credentials.create()`, exactly as the browser produced it — forwarded to the server untouched. (required)
$contentType : string = self::contentTypes['finishRegistration'][0]: The value for the Content-Type header. Check self::contentTypes['finishRegistration'] to see the possible values for this operation

Return values

array<string|int, mixed> —

of \ForgeDashboard\Generated\Model\SessionUser|\ForgeDashboard\Generated\Model\Error, HTTP status code, HTTP response headers (array of strings)

getConfig()


    public
                    getConfig() : Configuration

Return values

Configuration

getHostIndex()

Get the host index


    public
                    getHostIndex() : int

Return values

int —

Host index

getRegistrationStatus()

Operation getRegistrationStatus


    public
                    getRegistrationStatus([string $contentType = self::contentTypes['getRegistrationStatus'][0] ]) : RegistrationStatus

Whether self-registration is open

Parameters

$contentType : string = self::contentTypes['getRegistrationStatus'][0]: The value for the Content-Type header. Check self::contentTypes['getRegistrationStatus'] to see the possible values for this operation

Return values

RegistrationStatus

getRegistrationStatusAsync()

Operation getRegistrationStatusAsync


    public
                    getRegistrationStatusAsync([string $contentType = self::contentTypes['getRegistrationStatus'][0] ]) : PromiseInterface

Whether self-registration is open

Parameters

$contentType : string = self::contentTypes['getRegistrationStatus'][0]: The value for the Content-Type header. Check self::contentTypes['getRegistrationStatus'] to see the possible values for this operation

Return values

PromiseInterface

getRegistrationStatusAsyncWithHttpInfo()

Operation getRegistrationStatusAsyncWithHttpInfo


    public
                    getRegistrationStatusAsyncWithHttpInfo([string $contentType = self::contentTypes['getRegistrationStatus'][0] ]) : PromiseInterface

Whether self-registration is open

Parameters

$contentType : string = self::contentTypes['getRegistrationStatus'][0]: The value for the Content-Type header. Check self::contentTypes['getRegistrationStatus'] to see the possible values for this operation

Return values

PromiseInterface

getRegistrationStatusRequest()

Create request for operation 'getRegistrationStatus'


    public
                    getRegistrationStatusRequest([string $contentType = self::contentTypes['getRegistrationStatus'][0] ]) : Request

Parameters

$contentType : string = self::contentTypes['getRegistrationStatus'][0]: The value for the Content-Type header. Check self::contentTypes['getRegistrationStatus'] to see the possible values for this operation

Return values

Request

getRegistrationStatusWithHttpInfo()

Operation getRegistrationStatusWithHttpInfo


    public
                    getRegistrationStatusWithHttpInfo([string $contentType = self::contentTypes['getRegistrationStatus'][0] ]) : array<string|int, mixed>

Whether self-registration is open

Parameters

$contentType : string = self::contentTypes['getRegistrationStatus'][0]: The value for the Content-Type header. Check self::contentTypes['getRegistrationStatus'] to see the possible values for this operation

Return values

array<string|int, mixed> —

of \ForgeDashboard\Generated\Model\RegistrationStatus, HTTP status code, HTTP response headers (array of strings)

getSession()

Operation getSession


    public
                    getSession([string $contentType = self::contentTypes['getSession'][0] ]) : SessionUser|Error

Who, if anyone, the current session cookie belongs to

Parameters

$contentType : string = self::contentTypes['getSession'][0]: The value for the Content-Type header. Check self::contentTypes['getSession'] to see the possible values for this operation

Return values

SessionUser|Error

getSessionAsync()

Operation getSessionAsync


    public
                    getSessionAsync([string $contentType = self::contentTypes['getSession'][0] ]) : PromiseInterface

Who, if anyone, the current session cookie belongs to

Parameters

$contentType : string = self::contentTypes['getSession'][0]: The value for the Content-Type header. Check self::contentTypes['getSession'] to see the possible values for this operation

Return values

PromiseInterface

getSessionAsyncWithHttpInfo()

Operation getSessionAsyncWithHttpInfo


    public
                    getSessionAsyncWithHttpInfo([string $contentType = self::contentTypes['getSession'][0] ]) : PromiseInterface

Who, if anyone, the current session cookie belongs to

Parameters

$contentType : string = self::contentTypes['getSession'][0]: The value for the Content-Type header. Check self::contentTypes['getSession'] to see the possible values for this operation

Return values

PromiseInterface

getSessionRequest()

Create request for operation 'getSession'


    public
                    getSessionRequest([string $contentType = self::contentTypes['getSession'][0] ]) : Request

Parameters

$contentType : string = self::contentTypes['getSession'][0]: The value for the Content-Type header. Check self::contentTypes['getSession'] to see the possible values for this operation

Return values

Request

getSessionWithHttpInfo()

Operation getSessionWithHttpInfo


    public
                    getSessionWithHttpInfo([string $contentType = self::contentTypes['getSession'][0] ]) : array<string|int, mixed>

Who, if anyone, the current session cookie belongs to

Parameters

$contentType : string = self::contentTypes['getSession'][0]: The value for the Content-Type header. Check self::contentTypes['getSession'] to see the possible values for this operation

Return values

array<string|int, mixed> —

of \ForgeDashboard\Generated\Model\SessionUser|\ForgeDashboard\Generated\Model\Error, HTTP status code, HTTP response headers (array of strings)

listCredentials()

Operation listCredentials


    public
                    listCredentials([string $contentType = self::contentTypes['listCredentials'][0] ]) : array<string|int, Credential>|Error

List the signed-in user's own passkeys

Parameters

$contentType : string = self::contentTypes['listCredentials'][0]: The value for the Content-Type header. Check self::contentTypes['listCredentials'] to see the possible values for this operation

Return values

array<string|int, Credential>|Error

listCredentialsAsync()

Operation listCredentialsAsync


    public
                    listCredentialsAsync([string $contentType = self::contentTypes['listCredentials'][0] ]) : PromiseInterface

List the signed-in user's own passkeys

Parameters

$contentType : string = self::contentTypes['listCredentials'][0]: The value for the Content-Type header. Check self::contentTypes['listCredentials'] to see the possible values for this operation

Return values

PromiseInterface

listCredentialsAsyncWithHttpInfo()

Operation listCredentialsAsyncWithHttpInfo


    public
                    listCredentialsAsyncWithHttpInfo([string $contentType = self::contentTypes['listCredentials'][0] ]) : PromiseInterface

List the signed-in user's own passkeys

Parameters

$contentType : string = self::contentTypes['listCredentials'][0]: The value for the Content-Type header. Check self::contentTypes['listCredentials'] to see the possible values for this operation

Return values

PromiseInterface

listCredentialsRequest()

Create request for operation 'listCredentials'


    public
                    listCredentialsRequest([string $contentType = self::contentTypes['listCredentials'][0] ]) : Request

Parameters

$contentType : string = self::contentTypes['listCredentials'][0]: The value for the Content-Type header. Check self::contentTypes['listCredentials'] to see the possible values for this operation

Return values

Request

listCredentialsWithHttpInfo()

Operation listCredentialsWithHttpInfo


    public
                    listCredentialsWithHttpInfo([string $contentType = self::contentTypes['listCredentials'][0] ]) : array<string|int, mixed>

List the signed-in user's own passkeys

Parameters

$contentType : string = self::contentTypes['listCredentials'][0]: The value for the Content-Type header. Check self::contentTypes['listCredentials'] to see the possible values for this operation

Return values

array<string|int, mixed> —

of \ForgeDashboard\Generated\Model\Credential[]|\ForgeDashboard\Generated\Model\Error, HTTP status code, HTTP response headers (array of strings)

logout()

Operation logout


    public
                    logout([string $contentType = self::contentTypes['logout'][0] ]) : void

End the current session

Parameters

$contentType : string = self::contentTypes['logout'][0]: The value for the Content-Type header. Check self::contentTypes['logout'] to see the possible values for this operation

logoutAsync()

Operation logoutAsync


    public
                    logoutAsync([string $contentType = self::contentTypes['logout'][0] ]) : PromiseInterface

End the current session

Parameters

$contentType : string = self::contentTypes['logout'][0]: The value for the Content-Type header. Check self::contentTypes['logout'] to see the possible values for this operation

Return values

PromiseInterface

logoutAsyncWithHttpInfo()

Operation logoutAsyncWithHttpInfo


    public
                    logoutAsyncWithHttpInfo([string $contentType = self::contentTypes['logout'][0] ]) : PromiseInterface

End the current session

Parameters

$contentType : string = self::contentTypes['logout'][0]: The value for the Content-Type header. Check self::contentTypes['logout'] to see the possible values for this operation

Return values

PromiseInterface

logoutRequest()

Create request for operation 'logout'


    public
                    logoutRequest([string $contentType = self::contentTypes['logout'][0] ]) : Request

Parameters

$contentType : string = self::contentTypes['logout'][0]: The value for the Content-Type header. Check self::contentTypes['logout'] to see the possible values for this operation

Return values

Request

logoutWithHttpInfo()

Operation logoutWithHttpInfo


    public
                    logoutWithHttpInfo([string $contentType = self::contentTypes['logout'][0] ]) : array<string|int, mixed>

End the current session

Parameters

$contentType : string = self::contentTypes['logout'][0]: The value for the Content-Type header. Check self::contentTypes['logout'] to see the possible values for this operation

Return values

array<string|int, mixed> —

of null, HTTP status code, HTTP response headers (array of strings)

setHostIndex()

Set the host index


    public
                    setHostIndex(int $hostIndex) : void

Parameters

$hostIndex : int: Host index (required)

createHttpClientOption()

Create http client option


    protected
                    createHttpClientOption() : array<string|int, mixed>

Return values

array<string|int, mixed> —

of http client options

handleResponseWithDataType()


    private
                    handleResponseWithDataType(string $dataType, RequestInterface $request, ResponseInterface $response) : array<string|int, mixed>

Parameters

$dataType : string
$request : RequestInterface
$response : ResponseInterface

Return values

array<string|int, mixed>

responseWithinRangeCode()


    private
                    responseWithinRangeCode(string $rangeCode, int $statusCode) : bool

Parameters

$rangeCode : string
$statusCode : int

Return values

bool

AuthApi in package ForgeDashboard Generated

Tags

Table of Contents

Constants

Properties

Methods

Constants

contentTypes

Properties

$client

$config

$headerSelector

$hostIndex

Methods

__construct()

Parameters

beginAddCredential()

Parameters

Tags

Return values

beginAddCredentialAsync()

Parameters

Tags

Return values

beginAddCredentialAsyncWithHttpInfo()

Parameters

Tags

Return values

beginAddCredentialRequest()

Parameters

Tags

Return values

beginAddCredentialWithHttpInfo()

Parameters

Tags

Return values

beginLogin()

Parameters

Tags

Return values

beginLoginAsync()

Parameters

Tags

Return values

beginLoginAsyncWithHttpInfo()

Parameters

Tags

Return values

beginLoginRequest()

Parameters

Tags

Return values

beginLoginWithHttpInfo()

Parameters

Tags

Return values

beginRegistration()

Parameters

Tags

Return values

beginRegistrationAsync()

Parameters

Tags

Return values

beginRegistrationAsyncWithHttpInfo()

Parameters

Tags

Return values

beginRegistrationRequest()

Parameters

Tags

Return values

beginRegistrationWithHttpInfo()

Parameters

Tags

Return values

deleteCredential()

Parameters

Tags

deleteCredentialAsync()

AuthApi
in package

ForgeDashboard

Generated