All URIs are relative to https://share.catrob.at/api
| Method | HTTP request | Description |
|---|---|---|
| authenticationDelete | DELETE /authentication | Expires refresh token |
| authenticationGet | GET /authentication | Check JWT token validity |
| authenticationOauthPost | POST /authentication/oauth | OAuth Login |
| authenticationPost | POST /authentication | Login - create a new JWT token |
| authenticationRefreshPost | POST /authentication/refresh | Refresh token |
| authenticationUpgradePost | POST /authentication/upgrade | Upgrade a deprecated token to JWT |
# config/services.yaml
services:
# ...
Acme\MyBundle\Api\AuthenticationApi:
tags:
- { name: "open_api_server.api", api: "authentication" }
# ...authenticationDelete($x_refresh)
Expires refresh token
Sets refresh token to expired
<?php
// src/Acme/MyBundle/Api/AuthenticationApiInterface.php
namespace Acme\MyBundle\Api;
use OpenAPI\Server\Api\AuthenticationApiInterface;
class AuthenticationApi implements AuthenticationApiInterface
{
// ...
/**
* Implementation of AuthenticationApiInterface#authenticationDelete
*/
public function authenticationDelete(string $x_refresh, int &$responseCode, array &$responseHeaders): void
{
// Implement the operation ...
}
// ...
}| Name | Type | Description | Notes |
|---|---|---|---|
| x_refresh | string | Refresh Token |
void (empty response body)
- Content-Type: Not defined
- Accept: Not defined
[Back to top] [Back to API list] [Back to Model list] [Back to README]
authenticationGet()
Check JWT token validity
Checks if a token is valid or expired.
<?php
// src/Acme/MyBundle/Api/AuthenticationApiInterface.php
namespace Acme\MyBundle\Api;
use OpenAPI\Server\Api\AuthenticationApiInterface;
class AuthenticationApi implements AuthenticationApiInterface
{
// ...
/**
* Implementation of AuthenticationApiInterface#authenticationGet
*/
public function authenticationGet(int &$responseCode, array &$responseHeaders): void
{
// Implement the operation ...
}
// ...
}This endpoint does not need any parameter.
void (empty response body)
- Content-Type: Not defined
- Accept: Not defined
[Back to top] [Back to API list] [Back to Model list] [Back to README]
OpenAPI\Server\Model\JWTResponse authenticationOauthPost($o_auth_login_request)
OAuth Login
Returns an JWT token which provides authorization
<?php
// src/Acme/MyBundle/Api/AuthenticationApiInterface.php
namespace Acme\MyBundle\Api;
use OpenAPI\Server\Api\AuthenticationApiInterface;
class AuthenticationApi implements AuthenticationApiInterface
{
// ...
/**
* Implementation of AuthenticationApiInterface#authenticationOauthPost
*/
public function authenticationOauthPost(OAuthLoginRequest $o_auth_login_request, int &$responseCode, array &$responseHeaders): array|object|null
{
// Implement the operation ...
}
// ...
}| Name | Type | Description | Notes |
|---|---|---|---|
| o_auth_login_request | OpenAPI\Server\Model\OAuthLoginRequest |
OpenAPI\Server\Model\JWTResponse
No authorization required
- Content-Type: application/json
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
OpenAPI\Server\Model\JWTResponse authenticationPost($login_request)
Login - create a new JWT token
Returns an JWT token which provides authorization for a limited time
<?php
// src/Acme/MyBundle/Api/AuthenticationApiInterface.php
namespace Acme\MyBundle\Api;
use OpenAPI\Server\Api\AuthenticationApiInterface;
class AuthenticationApi implements AuthenticationApiInterface
{
// ...
/**
* Implementation of AuthenticationApiInterface#authenticationPost
*/
public function authenticationPost(LoginRequest $login_request, int &$responseCode, array &$responseHeaders): array|object|null
{
// Implement the operation ...
}
// ...
}| Name | Type | Description | Notes |
|---|---|---|---|
| login_request | OpenAPI\Server\Model\LoginRequest |
OpenAPI\Server\Model\JWTResponse
- Content-Type: application/json
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
OpenAPI\Server\Model\JWTResponse authenticationRefreshPost($refresh_request)
Refresh token
Returns a new JWT token with help of the refresh token
<?php
// src/Acme/MyBundle/Api/AuthenticationApiInterface.php
namespace Acme\MyBundle\Api;
use OpenAPI\Server\Api\AuthenticationApiInterface;
class AuthenticationApi implements AuthenticationApiInterface
{
// ...
/**
* Implementation of AuthenticationApiInterface#authenticationRefreshPost
*/
public function authenticationRefreshPost(RefreshRequest $refresh_request, int &$responseCode, array &$responseHeaders): array|object|null
{
// Implement the operation ...
}
// ...
}| Name | Type | Description | Notes |
|---|---|---|---|
| refresh_request | OpenAPI\Server\Model\RefreshRequest |
OpenAPI\Server\Model\JWTResponse
- Content-Type: application/json
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
OpenAPI\Server\Model\JWTResponse authenticationUpgradePost($upgrade_token_request)
Upgrade a deprecated token to JWT
Returns a new JWT token with help of a deprecated upload_token. This allows users to stay signed in apps during the transition to the new API.
<?php
// src/Acme/MyBundle/Api/AuthenticationApiInterface.php
namespace Acme\MyBundle\Api;
use OpenAPI\Server\Api\AuthenticationApiInterface;
class AuthenticationApi implements AuthenticationApiInterface
{
// ...
/**
* Implementation of AuthenticationApiInterface#authenticationUpgradePost
*/
public function authenticationUpgradePost(UpgradeTokenRequest $upgrade_token_request, int &$responseCode, array &$responseHeaders): array|object|null
{
// Implement the operation ...
}
// ...
}| Name | Type | Description | Notes |
|---|---|---|---|
| upgrade_token_request | OpenAPI\Server\Model\UpgradeTokenRequest |
OpenAPI\Server\Model\JWTResponse
No authorization required
- Content-Type: application/json
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]