forge-dashboard-sdk-php

AdminApi
in package

ForgeDashboard

Generated

AdminApi Class Doc Comment

Constants

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

Properties

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

Methods

__construct() : mixed
createInvite() : AdminInviteCreateResponse|Error: Operation createInvite
createInviteAsync() : PromiseInterface: Operation createInviteAsync
createInviteAsyncWithHttpInfo() : PromiseInterface: Operation createInviteAsyncWithHttpInfo
createInviteRequest() : Request: Create request for operation 'createInvite'
createInviteWithHttpInfo() : array<string|int, mixed>: Operation createInviteWithHttpInfo
deleteUser() : void: Operation deleteUser
deleteUserAsync() : PromiseInterface: Operation deleteUserAsync
deleteUserAsyncWithHttpInfo() : PromiseInterface: Operation deleteUserAsyncWithHttpInfo
deleteUserRequest() : Request: Create request for operation 'deleteUser'
deleteUserWithHttpInfo() : array<string|int, mixed>: Operation deleteUserWithHttpInfo
exportRequests() : string|Error: Operation exportRequests
exportRequestsAsync() : PromiseInterface: Operation exportRequestsAsync
exportRequestsAsyncWithHttpInfo() : PromiseInterface: Operation exportRequestsAsyncWithHttpInfo
exportRequestsRequest() : Request: Create request for operation 'exportRequests'
exportRequestsWithHttpInfo() : array<string|int, mixed>: Operation exportRequestsWithHttpInfo
getConfig() : Configuration
getHostIndex() : int: Get the host index
listInvites() : array<string|int, AdminInvite>|Error: Operation listInvites
listInvitesAsync() : PromiseInterface: Operation listInvitesAsync
listInvitesAsyncWithHttpInfo() : PromiseInterface: Operation listInvitesAsyncWithHttpInfo
listInvitesRequest() : Request: Create request for operation 'listInvites'
listInvitesWithHttpInfo() : array<string|int, mixed>: Operation listInvitesWithHttpInfo
listRequests() : array<string|int, RequestLogEntry>|Error: Operation listRequests
listRequestsAsync() : PromiseInterface: Operation listRequestsAsync
listRequestsAsyncWithHttpInfo() : PromiseInterface: Operation listRequestsAsyncWithHttpInfo
listRequestsRequest() : Request: Create request for operation 'listRequests'
listRequestsWithHttpInfo() : array<string|int, mixed>: Operation listRequestsWithHttpInfo
listUsers() : array<string|int, AdminUser>|Error: Operation listUsers
listUsersAsync() : PromiseInterface: Operation listUsersAsync
listUsersAsyncWithHttpInfo() : PromiseInterface: Operation listUsersAsyncWithHttpInfo
listUsersRequest() : Request: Create request for operation 'listUsers'
listUsersWithHttpInfo() : array<string|int, mixed>: Operation listUsersWithHttpInfo
revokeInvite() : void: Operation revokeInvite
revokeInviteAsync() : PromiseInterface: Operation revokeInviteAsync
revokeInviteAsyncWithHttpInfo() : PromiseInterface: Operation revokeInviteAsyncWithHttpInfo
revokeInviteRequest() : Request: Create request for operation 'revokeInvite'
revokeInviteWithHttpInfo() : array<string|int, mixed>: Operation revokeInviteWithHttpInfo
revokeUser() : void: Operation revokeUser
revokeUserAsync() : PromiseInterface: Operation revokeUserAsync
revokeUserAsyncWithHttpInfo() : PromiseInterface: Operation revokeUserAsyncWithHttpInfo
revokeUserRequest() : Request: Create request for operation 'revokeUser'
revokeUserWithHttpInfo() : array<string|int, mixed>: Operation revokeUserWithHttpInfo
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
    = ['createInvite' => ['application/json'], 'deleteUser' => ['application/json'], 'exportRequests' => ['application/json'], 'listInvites' => ['application/json'], 'listRequests' => ['application/json'], 'listUsers' => ['application/json'], 'revokeInvite' => ['application/json'], 'revokeUser' => ['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

createInvite()

Operation createInvite


    public
                    createInvite(AdminInviteCreateRequest $admin_invite_create_request[, string $contentType = self::contentTypes['createInvite'][0] ]) : AdminInviteCreateResponse|Error

Generate a new single-use registration invite

Parameters

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

Return values

AdminInviteCreateResponse|Error

createInviteAsync()

Operation createInviteAsync


    public
                    createInviteAsync(AdminInviteCreateRequest $admin_invite_create_request[, string $contentType = self::contentTypes['createInvite'][0] ]) : PromiseInterface

Generate a new single-use registration invite

Parameters

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

Return values

PromiseInterface

createInviteAsyncWithHttpInfo()

Operation createInviteAsyncWithHttpInfo


    public
                    createInviteAsyncWithHttpInfo(AdminInviteCreateRequest $admin_invite_create_request[, string $contentType = self::contentTypes['createInvite'][0] ]) : PromiseInterface

Generate a new single-use registration invite

Parameters

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

Return values

PromiseInterface

createInviteRequest()

Create request for operation 'createInvite'


    public
                    createInviteRequest(AdminInviteCreateRequest $admin_invite_create_request[, string $contentType = self::contentTypes['createInvite'][0] ]) : Request

Parameters

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

Return values

Request

createInviteWithHttpInfo()

Operation createInviteWithHttpInfo


    public
                    createInviteWithHttpInfo(AdminInviteCreateRequest $admin_invite_create_request[, string $contentType = self::contentTypes['createInvite'][0] ]) : array<string|int, mixed>

Generate a new single-use registration invite

Parameters

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

Return values

array<string|int, mixed> —

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

deleteUser()

Operation deleteUser


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

Remove a user outright

Parameters

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

deleteUserAsync()

Operation deleteUserAsync


    public
                    deleteUserAsync(string $username[, string $contentType = self::contentTypes['deleteUser'][0] ]) : PromiseInterface

Remove a user outright

Parameters

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

Return values

PromiseInterface

deleteUserAsyncWithHttpInfo()

Operation deleteUserAsyncWithHttpInfo


    public
                    deleteUserAsyncWithHttpInfo(string $username[, string $contentType = self::contentTypes['deleteUser'][0] ]) : PromiseInterface

Remove a user outright

Parameters

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

Return values

PromiseInterface

deleteUserRequest()

Create request for operation 'deleteUser'


    public
                    deleteUserRequest(string $username[, string $contentType = self::contentTypes['deleteUser'][0] ]) : Request

Parameters

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

Return values

Request

deleteUserWithHttpInfo()

Operation deleteUserWithHttpInfo


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

Remove a user outright

Parameters

$username : string: (required)
$contentType : string = self::contentTypes['deleteUser'][0]: The value for the Content-Type header. Check self::contentTypes['deleteUser'] 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)

exportRequests()

Operation exportRequests


    public
                    exportRequests([Forge|null $forge = null ][, string|null $account = null ][, string $contentType = self::contentTypes['exportRequests'][0] ]) : string|Error

Export the (filtered) outbound-request log as CSV

Parameters

$forge : Forge|null = null: Narrow to entries against this forge only. Omitted matches every forge. (optional)
$account : string|null = null: Narrow to entries made under this account's own credential only — the account's `username` (matching RequestLogEntry.account), not its internal id. An unrecognized username matches nothing rather than erroring, the same as any other filter with no matches. Omitted matches every account. (optional)
$contentType : string = self::contentTypes['exportRequests'][0]: The value for the Content-Type header. Check self::contentTypes['exportRequests'] to see the possible values for this operation

Return values

string|Error

exportRequestsAsync()

Operation exportRequestsAsync


    public
                    exportRequestsAsync([Forge|null $forge = null ][, string|null $account = null ][, string $contentType = self::contentTypes['exportRequests'][0] ]) : PromiseInterface

Export the (filtered) outbound-request log as CSV

Parameters

$forge : Forge|null = null: Narrow to entries against this forge only. Omitted matches every forge. (optional)
$account : string|null = null: Narrow to entries made under this account's own credential only — the account's `username` (matching RequestLogEntry.account), not its internal id. An unrecognized username matches nothing rather than erroring, the same as any other filter with no matches. Omitted matches every account. (optional)
$contentType : string = self::contentTypes['exportRequests'][0]: The value for the Content-Type header. Check self::contentTypes['exportRequests'] to see the possible values for this operation

Return values

PromiseInterface

exportRequestsAsyncWithHttpInfo()

Operation exportRequestsAsyncWithHttpInfo


    public
                    exportRequestsAsyncWithHttpInfo([Forge|null $forge = null ][, string|null $account = null ][, string $contentType = self::contentTypes['exportRequests'][0] ]) : PromiseInterface

Export the (filtered) outbound-request log as CSV

Parameters

$forge : Forge|null = null: Narrow to entries against this forge only. Omitted matches every forge. (optional)
$account : string|null = null: Narrow to entries made under this account's own credential only — the account's `username` (matching RequestLogEntry.account), not its internal id. An unrecognized username matches nothing rather than erroring, the same as any other filter with no matches. Omitted matches every account. (optional)
$contentType : string = self::contentTypes['exportRequests'][0]: The value for the Content-Type header. Check self::contentTypes['exportRequests'] to see the possible values for this operation

Return values

PromiseInterface

exportRequestsRequest()

Create request for operation 'exportRequests'


    public
                    exportRequestsRequest([Forge|null $forge = null ][, string|null $account = null ][, string $contentType = self::contentTypes['exportRequests'][0] ]) : Request

Parameters

$forge : Forge|null = null: Narrow to entries against this forge only. Omitted matches every forge. (optional)
$account : string|null = null: Narrow to entries made under this account's own credential only — the account's `username` (matching RequestLogEntry.account), not its internal id. An unrecognized username matches nothing rather than erroring, the same as any other filter with no matches. Omitted matches every account. (optional)
$contentType : string = self::contentTypes['exportRequests'][0]: The value for the Content-Type header. Check self::contentTypes['exportRequests'] to see the possible values for this operation

Return values

Request

exportRequestsWithHttpInfo()

Operation exportRequestsWithHttpInfo


    public
                    exportRequestsWithHttpInfo([Forge|null $forge = null ][, string|null $account = null ][, string $contentType = self::contentTypes['exportRequests'][0] ]) : array<string|int, mixed>

Export the (filtered) outbound-request log as CSV

Parameters

$forge : Forge|null = null: Narrow to entries against this forge only. Omitted matches every forge. (optional)
$account : string|null = null: Narrow to entries made under this account's own credential only — the account's `username` (matching RequestLogEntry.account), not its internal id. An unrecognized username matches nothing rather than erroring, the same as any other filter with no matches. Omitted matches every account. (optional)
$contentType : string = self::contentTypes['exportRequests'][0]: The value for the Content-Type header. Check self::contentTypes['exportRequests'] to see the possible values for this operation

Return values

array<string|int, mixed> —

of string|\ForgeDashboard\Generated\Model\Error|\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

listInvites()

Operation listInvites


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

List outstanding registration invites

Parameters

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

Return values

array<string|int, AdminInvite>|Error

listInvitesAsync()

Operation listInvitesAsync


    public
                    listInvitesAsync([string $contentType = self::contentTypes['listInvites'][0] ]) : PromiseInterface

List outstanding registration invites

Parameters

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

Return values

PromiseInterface

listInvitesAsyncWithHttpInfo()

Operation listInvitesAsyncWithHttpInfo


    public
                    listInvitesAsyncWithHttpInfo([string $contentType = self::contentTypes['listInvites'][0] ]) : PromiseInterface

List outstanding registration invites

Parameters

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

Return values

PromiseInterface

listInvitesRequest()

Create request for operation 'listInvites'


    public
                    listInvitesRequest([string $contentType = self::contentTypes['listInvites'][0] ]) : Request

Parameters

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

Return values

Request

listInvitesWithHttpInfo()

Operation listInvitesWithHttpInfo


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

List outstanding registration invites

Parameters

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

Return values

array<string|int, mixed> —

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

listRequests()

Operation listRequests


    public
                    listRequests([Forge|null $forge = null ][, string|null $account = null ][, string $contentType = self::contentTypes['listRequests'][0] ]) : array<string|int, RequestLogEntry>|Error

List every outbound GitHub/Forgejo request this instance has made

Parameters

$forge : Forge|null = null: Narrow to entries against this forge only. Omitted matches every forge. (optional)
$account : string|null = null: Narrow to entries made under this account's own credential only — the account's `username` (matching RequestLogEntry.account), not its internal id. An unrecognized username matches nothing rather than erroring, the same as any other filter with no matches. Omitted matches every account. (optional)
$contentType : string = self::contentTypes['listRequests'][0]: The value for the Content-Type header. Check self::contentTypes['listRequests'] to see the possible values for this operation

Return values

array<string|int, RequestLogEntry>|Error

listRequestsAsync()

Operation listRequestsAsync


    public
                    listRequestsAsync([Forge|null $forge = null ][, string|null $account = null ][, string $contentType = self::contentTypes['listRequests'][0] ]) : PromiseInterface

List every outbound GitHub/Forgejo request this instance has made

Parameters

$forge : Forge|null = null: Narrow to entries against this forge only. Omitted matches every forge. (optional)
$account : string|null = null: Narrow to entries made under this account's own credential only — the account's `username` (matching RequestLogEntry.account), not its internal id. An unrecognized username matches nothing rather than erroring, the same as any other filter with no matches. Omitted matches every account. (optional)
$contentType : string = self::contentTypes['listRequests'][0]: The value for the Content-Type header. Check self::contentTypes['listRequests'] to see the possible values for this operation

Return values

PromiseInterface

listRequestsAsyncWithHttpInfo()

Operation listRequestsAsyncWithHttpInfo


    public
                    listRequestsAsyncWithHttpInfo([Forge|null $forge = null ][, string|null $account = null ][, string $contentType = self::contentTypes['listRequests'][0] ]) : PromiseInterface

List every outbound GitHub/Forgejo request this instance has made

Parameters

$forge : Forge|null = null: Narrow to entries against this forge only. Omitted matches every forge. (optional)
$account : string|null = null: Narrow to entries made under this account's own credential only — the account's `username` (matching RequestLogEntry.account), not its internal id. An unrecognized username matches nothing rather than erroring, the same as any other filter with no matches. Omitted matches every account. (optional)
$contentType : string = self::contentTypes['listRequests'][0]: The value for the Content-Type header. Check self::contentTypes['listRequests'] to see the possible values for this operation

Return values

PromiseInterface

listRequestsRequest()

Create request for operation 'listRequests'


    public
                    listRequestsRequest([Forge|null $forge = null ][, string|null $account = null ][, string $contentType = self::contentTypes['listRequests'][0] ]) : Request

Parameters

$forge : Forge|null = null: Narrow to entries against this forge only. Omitted matches every forge. (optional)
$account : string|null = null: Narrow to entries made under this account's own credential only — the account's `username` (matching RequestLogEntry.account), not its internal id. An unrecognized username matches nothing rather than erroring, the same as any other filter with no matches. Omitted matches every account. (optional)
$contentType : string = self::contentTypes['listRequests'][0]: The value for the Content-Type header. Check self::contentTypes['listRequests'] to see the possible values for this operation

Return values

Request

listRequestsWithHttpInfo()

Operation listRequestsWithHttpInfo


    public
                    listRequestsWithHttpInfo([Forge|null $forge = null ][, string|null $account = null ][, string $contentType = self::contentTypes['listRequests'][0] ]) : array<string|int, mixed>

List every outbound GitHub/Forgejo request this instance has made

Parameters

$forge : Forge|null = null: Narrow to entries against this forge only. Omitted matches every forge. (optional)
$account : string|null = null: Narrow to entries made under this account's own credential only — the account's `username` (matching RequestLogEntry.account), not its internal id. An unrecognized username matches nothing rather than erroring, the same as any other filter with no matches. Omitted matches every account. (optional)
$contentType : string = self::contentTypes['listRequests'][0]: The value for the Content-Type header. Check self::contentTypes['listRequests'] to see the possible values for this operation

Return values

array<string|int, mixed> —

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

listUsers()

Operation listUsers


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

List every registered user

Parameters

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

Return values

array<string|int, AdminUser>|Error

listUsersAsync()

Operation listUsersAsync


    public
                    listUsersAsync([string $contentType = self::contentTypes['listUsers'][0] ]) : PromiseInterface

List every registered user

Parameters

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

Return values

PromiseInterface

listUsersAsyncWithHttpInfo()

Operation listUsersAsyncWithHttpInfo


    public
                    listUsersAsyncWithHttpInfo([string $contentType = self::contentTypes['listUsers'][0] ]) : PromiseInterface

List every registered user

Parameters

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

Return values

PromiseInterface

listUsersRequest()

Create request for operation 'listUsers'


    public
                    listUsersRequest([string $contentType = self::contentTypes['listUsers'][0] ]) : Request

Parameters

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

Return values

Request

listUsersWithHttpInfo()

Operation listUsersWithHttpInfo


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

List every registered user

Parameters

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

Return values

array<string|int, mixed> —

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

revokeInvite()

Operation revokeInvite


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

Revoke an outstanding invite

Parameters

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

revokeInviteAsync()

Operation revokeInviteAsync


    public
                    revokeInviteAsync(string $token[, string $contentType = self::contentTypes['revokeInvite'][0] ]) : PromiseInterface

Revoke an outstanding invite

Parameters

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

Return values

PromiseInterface

revokeInviteAsyncWithHttpInfo()

Operation revokeInviteAsyncWithHttpInfo


    public
                    revokeInviteAsyncWithHttpInfo(string $token[, string $contentType = self::contentTypes['revokeInvite'][0] ]) : PromiseInterface

Revoke an outstanding invite

Parameters

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

Return values

PromiseInterface

revokeInviteRequest()

Create request for operation 'revokeInvite'


    public
                    revokeInviteRequest(string $token[, string $contentType = self::contentTypes['revokeInvite'][0] ]) : Request

Parameters

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

Return values

Request

revokeInviteWithHttpInfo()

Operation revokeInviteWithHttpInfo


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

Revoke an outstanding invite

Parameters

$token : string: (required)
$contentType : string = self::contentTypes['revokeInvite'][0]: The value for the Content-Type header. Check self::contentTypes['revokeInvite'] 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)

revokeUser()

Operation revokeUser


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

Revoke a user's passkeys and sessions

Parameters

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

revokeUserAsync()

Operation revokeUserAsync


    public
                    revokeUserAsync(string $username[, string $contentType = self::contentTypes['revokeUser'][0] ]) : PromiseInterface

Revoke a user's passkeys and sessions

Parameters

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

Return values

PromiseInterface

revokeUserAsyncWithHttpInfo()

Operation revokeUserAsyncWithHttpInfo


    public
                    revokeUserAsyncWithHttpInfo(string $username[, string $contentType = self::contentTypes['revokeUser'][0] ]) : PromiseInterface

Revoke a user's passkeys and sessions

Parameters

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

Return values

PromiseInterface

revokeUserRequest()

Create request for operation 'revokeUser'


    public
                    revokeUserRequest(string $username[, string $contentType = self::contentTypes['revokeUser'][0] ]) : Request

Parameters

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

Return values

Request

revokeUserWithHttpInfo()

Operation revokeUserWithHttpInfo


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

Revoke a user's passkeys and sessions

Parameters

$username : string: (required)
$contentType : string = self::contentTypes['revokeUser'][0]: The value for the Content-Type header. Check self::contentTypes['revokeUser'] 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

AdminApi in package ForgeDashboard Generated

Tags

Table of Contents

Constants

Properties

Methods

Constants

contentTypes

Properties

$client

$config

$headerSelector

$hostIndex

Methods

__construct()

Parameters

createInvite()

Parameters

Tags

Return values

createInviteAsync()

Parameters

Tags

Return values

createInviteAsyncWithHttpInfo()

Parameters

Tags

Return values

createInviteRequest()

Parameters

Tags

Return values

createInviteWithHttpInfo()

Parameters

Tags

Return values

deleteUser()

Parameters

Tags

deleteUserAsync()

Parameters

Tags

Return values

deleteUserAsyncWithHttpInfo()

Parameters

Tags

Return values

deleteUserRequest()

Parameters

Tags

Return values

deleteUserWithHttpInfo()

Parameters

Tags

Return values

exportRequests()

Parameters

Tags

Return values

exportRequestsAsync()

Parameters

Tags

Return values

exportRequestsAsyncWithHttpInfo()

Parameters

Tags

Return values

exportRequestsRequest()

Parameters

Tags

Return values

exportRequestsWithHttpInfo()

Parameters

Tags

Return values

getConfig()

Return values

getHostIndex()

Return values

listInvites()

AdminApi
in package

ForgeDashboard

Generated