API introspection – List packages, resources and their interfaces

Found 2 resources

Resource class Smartarchivo\Controller\Report\ReportApi\V1\AuthenticateController of type ServiceController
No access control

Skeleton service controller class

Interfaces

Found 3 interfaces in class Smartarchivo\Controller\Report\ReportApi\V1\AuthenticateController

Resource: Authenticate, Method: report

API service method providing actor authentication and JSON web token backed sessions handling.
See jwt.io for more details.

Requires the users mail address or username as User.

Throws a ApiClientException, NotAllowedException, a RequestException or an AuthenticationFailedException
if identification fails. Exception codes have the following reasons:

  • 100300 Request is no JSON API request
  • 100301 Request is no PUT request
  • 100302 Request contains no valid account credentials
  • 100303 Request contains no valid account credentials
  • 100304 Request contains no valid account credentials
  • 100305 Request contains no valid account credentials
  • 100306 Request contains no valid account credentials
  • 100307 Actor has no client access
  • 100308 Actor has no facility access
  • 100309 Could not start a new token session
Endpoint
PUT /report/report-api/v1/authenticate/report/
Example request 
PUT /report/report-api/v1/authenticate/report
Host: /
Accept: application/json
Content-Type: application/json
Content-Length: 101
Accept-Language: de-DE, de;q=0.9, en;q=0.8, fr;q=0.7, *;q=0.5
{
    "ReportUuid": "123e4567-e89b-12d3-a456-426614174000",
    "Password": "super secret password"
}

HTTP/1.1 200 Ok
Date: Tue, 24 Sep 2024 08:55:34 +0000
Content-Length: 157
Content-Type: application/json
{
    "JsonWebToken": {
        "Token": "aHgxbjlpMTh3b3doczAzbDo4ODEwNzY0NC00MzE3LTRjY2ItYWE4MC0wYmQzYjkxOGZiYjQ=",
        "ValidUntil": 1591868066
    }
}
Request data
String named ReportUuid
String named Password
Response data
Object named JsonWebToken

Resource: Authenticate, Method: fileDownloadToken

API service method providing functionality to recieve a file download one time token

Endpoint
GET /report/report-api/v1/authenticate/file-download-token/
Example request 
GET /report/report-api/v1/authenticate/file-download-token
Host: /
Accept: application/json
Accept-Language: de-DE, de;q=0.9, en;q=0.8, fr;q=0.7, *;q=0.5
Authorization: Bearer aHgxbjlpMTh3b3doczAzbDo4ODEwNzY0NC00MzE3LTRjY2ItYWE4MC0wYmQzYjkxOGZiYjQ=

HTTP/1.1 200 Ok
Date: Tue, 24 Sep 2024 08:55:34 +0000
Content-Length: 67
Content-Type: application/json
{
    "FileDownloadToken": "123e4567-e89b-12d3-a456-426655440000"
}
Request header
Bearer JSON Web Token String named Authorization
Response data
String named FileDownloadToken

Resource: Authenticate, Method: test

API service method provides testing a received JSON web token
See jwt.io for more details.

Endpoint
GET /report/report-api/v1/authenticate/test/
Example request 
GET /report/report-api/v1/authenticate/test
Host: /
Accept: application/json
Accept-Language: de-DE, de;q=0.9, en;q=0.8, fr;q=0.7, *;q=0.5
Authorization: Bearer aHgxbjlpMTh3b3doczAzbDo4ODEwNzY0NC00MzE3LTRjY2ItYWE4MC0wYmQzYjkxOGZiYjQ=

HTTP/1.1 200 Ok
Date: Tue, 24 Sep 2024 08:55:34 +0000
Content-Length: 22
Content-Type: application/json
{
    "Result": "ok"
}
Request header
Bearer JSON Web Token String named Authorization
Response data
String named Result