Jalismrs\Stalactite\Client\Auth\ServerAppsApi

All URIs are relative to https://stalactite.jalis.dev/auth.

Method	HTTP request	Description
createServerApp()	POST /serverApps
deleteServerApp()	DELETE /serverApps/{uid}
getServerApp()	GET /serverApps/{uid}
getServerApps()	GET /serverApps
resetServerAppTokenSignatureKey()	PUT /serverApps/{uid}/tokenSignatureKey/reset
updateServerApp()	PUT /serverApps/{uid}

`createServerApp()`

createServerApp($create_server_app_request): \Jalismrs\Stalactite\Client\Auth\Model\ServerApp

Create and get a serverApp

Example

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


// Configure API key authorization: StalactiteToken
$config = Jalismrs\Stalactite\Client\Auth\Configuration::getDefaultConfiguration()->setApiKey('X-API-TOKEN', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = Jalismrs\Stalactite\Client\Auth\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-API-TOKEN', 'Bearer');


$apiInstance = new Jalismrs\Stalactite\Client\Auth\Api\ServerAppsApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client(),
    $config
);
$create_server_app_request = new \Jalismrs\Stalactite\Client\Auth\Model\CreateServerAppRequest(); // \Jalismrs\Stalactite\Client\Auth\Model\CreateServerAppRequest

try {
    $result = $apiInstance->createServerApp($create_server_app_request);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ServerAppsApi->createServerApp: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name	Type	Description	Notes
create_server_app_request	\Jalismrs\Stalactite\Client\Auth\Model\CreateServerAppRequest

Return type

\Jalismrs\Stalactite\Client\Auth\Model\ServerApp

Authorization

StalactiteToken

HTTP request headers

Content-Type: application/json
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

`deleteServerApp()`

deleteServerApp($uid)

Delete a serverApp based on its uid

Example

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


// Configure API key authorization: StalactiteToken
$config = Jalismrs\Stalactite\Client\Auth\Configuration::getDefaultConfiguration()->setApiKey('X-API-TOKEN', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = Jalismrs\Stalactite\Client\Auth\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-API-TOKEN', 'Bearer');


$apiInstance = new Jalismrs\Stalactite\Client\Auth\Api\ServerAppsApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client(),
    $config
);
$uid = 'uid_example'; // string | The uid of the serverApp to delete

try {
    $apiInstance->deleteServerApp($uid);
} catch (Exception $e) {
    echo 'Exception when calling ServerAppsApi->deleteServerApp: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name	Type	Description	Notes
uid	string	The uid of the serverApp to delete

Return type

void (empty response body)

Authorization

StalactiteToken

HTTP request headers

Content-Type: Not defined
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

`getServerApp()`

getServerApp($uid): \Jalismrs\Stalactite\Client\Auth\Model\ServerApp

Get a serverApp by its uid

Example

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


// Configure API key authorization: StalactiteToken
$config = Jalismrs\Stalactite\Client\Auth\Configuration::getDefaultConfiguration()->setApiKey('X-API-TOKEN', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = Jalismrs\Stalactite\Client\Auth\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-API-TOKEN', 'Bearer');


$apiInstance = new Jalismrs\Stalactite\Client\Auth\Api\ServerAppsApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client(),
    $config
);
$uid = 'uid_example'; // string | The uid of the serverApp to get

try {
    $result = $apiInstance->getServerApp($uid);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ServerAppsApi->getServerApp: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name	Type	Description	Notes
uid	string	The uid of the serverApp to get

Return type

\Jalismrs\Stalactite\Client\Auth\Model\ServerApp

Authorization

StalactiteToken

HTTP request headers

Content-Type: Not defined
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

`getServerApps()`

getServerApps($page, $name): \Jalismrs\Stalactite\Client\Auth\Model\GetServerAppsResponse

Get all serverApps with pagination support. A name filter can be applied

Example

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


// Configure API key authorization: StalactiteToken
$config = Jalismrs\Stalactite\Client\Auth\Configuration::getDefaultConfiguration()->setApiKey('X-API-TOKEN', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = Jalismrs\Stalactite\Client\Auth\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-API-TOKEN', 'Bearer');


$apiInstance = new Jalismrs\Stalactite\Client\Auth\Api\ServerAppsApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client(),
    $config
);
$page = 56; // int | Specify the page to get. default: 1
$name = 'name_example'; // string | Filter serverApps by name

try {
    $result = $apiInstance->getServerApps($page, $name);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ServerAppsApi->getServerApps: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name	Type	Description	Notes
page	int	Specify the page to get. default: 1	[optional]
name	string	Filter serverApps by name	[optional]

Return type

\Jalismrs\Stalactite\Client\Auth\Model\GetServerAppsResponse

Authorization

StalactiteToken

HTTP request headers

Content-Type: Not defined
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

`resetServerAppTokenSignatureKey()`

resetServerAppTokenSignatureKey($uid, $reset_server_app_token_signature_key_request): \Jalismrs\Stalactite\Client\Auth\Model\ServerApp

Reset a serverApp token signature key based on its uid and its current key

Example

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


// Configure API key authorization: StalactiteToken
$config = Jalismrs\Stalactite\Client\Auth\Configuration::getDefaultConfiguration()->setApiKey('X-API-TOKEN', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = Jalismrs\Stalactite\Client\Auth\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-API-TOKEN', 'Bearer');


$apiInstance = new Jalismrs\Stalactite\Client\Auth\Api\ServerAppsApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client(),
    $config
);
$uid = 'uid_example'; // string | The uid of the serverApp to reset its token signature key
$reset_server_app_token_signature_key_request = new \Jalismrs\Stalactite\Client\Auth\Model\ResetServerAppTokenSignatureKeyRequest(); // \Jalismrs\Stalactite\Client\Auth\Model\ResetServerAppTokenSignatureKeyRequest

try {
    $result = $apiInstance->resetServerAppTokenSignatureKey($uid, $reset_server_app_token_signature_key_request);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ServerAppsApi->resetServerAppTokenSignatureKey: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name	Type	Description	Notes
uid	string	The uid of the serverApp to reset its token signature key
reset_server_app_token_signature_key_request	\Jalismrs\Stalactite\Client\Auth\Model\ResetServerAppTokenSignatureKeyRequest

Return type

\Jalismrs\Stalactite\Client\Auth\Model\ServerApp

Authorization

StalactiteToken

HTTP request headers

Content-Type: application/json
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

`updateServerApp()`

updateServerApp($uid, $update_server_app_request)

Update a serverApp based on its uid

Example

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


// Configure API key authorization: StalactiteToken
$config = Jalismrs\Stalactite\Client\Auth\Configuration::getDefaultConfiguration()->setApiKey('X-API-TOKEN', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = Jalismrs\Stalactite\Client\Auth\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-API-TOKEN', 'Bearer');


$apiInstance = new Jalismrs\Stalactite\Client\Auth\Api\ServerAppsApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client(),
    $config
);
$uid = 'uid_example'; // string | The uid of the serverApp to update
$update_server_app_request = new \Jalismrs\Stalactite\Client\Auth\Model\UpdateServerAppRequest(); // \Jalismrs\Stalactite\Client\Auth\Model\UpdateServerAppRequest

try {
    $apiInstance->updateServerApp($uid, $update_server_app_request);
} catch (Exception $e) {
    echo 'Exception when calling ServerAppsApi->updateServerApp: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name	Type	Description	Notes
uid	string	The uid of the serverApp to update
update_server_app_request	\Jalismrs\Stalactite\Client\Auth\Model\UpdateServerAppRequest

Return type

void (empty response body)

Authorization

StalactiteToken

HTTP request headers

Content-Type: application/json
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

Files

ServerAppsApi.md

Latest commit

History

ServerAppsApi.md

File metadata and controls

Jalismrs\Stalactite\Client\Auth\ServerAppsApi

createServerApp()

Example

Parameters

Return type

Authorization

HTTP request headers

deleteServerApp()

Example

Parameters

Return type

Authorization

HTTP request headers

getServerApp()

Example

Parameters

Return type

Authorization

HTTP request headers

getServerApps()

Example

Parameters

Return type

Authorization

HTTP request headers

resetServerAppTokenSignatureKey()

Example

Parameters

Return type

Authorization

HTTP request headers

updateServerApp()

Example

Parameters

Return type

Authorization

HTTP request headers

`createServerApp()`

`deleteServerApp()`

`getServerApp()`

`getServerApps()`

`resetServerAppTokenSignatureKey()`

`updateServerApp()`