API introspection – List packages, resources and their interfaces

Found 2 resources

Resource class Tesa\Flow\Controller\Core\Api\V1\AuthenticateController of type ServiceController
No access control

Skeleton service controller class

Interfaces

Found 4 interfaces in class Tesa\Flow\Controller\Core\Api\V1\AuthenticateController

Resource: Authenticate, Method: actor

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

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
Endpoint
PUT /core/api/v1/authenticate/actor/
Example request 
PUT /core/api/v1/authenticate/actor
Host: /
Accept: application/json
Content-Type: application/json
Content-Length: 85
{
    "MailAddress": "john.doe@domain.com",
    "Password": "super secret password"
}

HTTP/1.1 200 Ok
Date: Wed, 30 Sep 2020 12:55:39 +0000
Content-Length: 599
Content-Type: application/json
{
    "JsonWebToken": {
        "Token": "aHgxbjlpMTh3b3doczAzbDo4ODEwNzY0NC00MzE3LTRjY2ItYWE4MC0wYmQzYjkxOGZiYjQ=",
        "ValidUntil": 1591868066
    },
    "Actor": {
        "Uuid": "faeb338f-1ab5-4edc-ba59-90f5d0abcf52",
        "MailAddress": "john.doe@domain.com",
        "Realname": "John Archibald Doe",
        "SupervisorMailAddress": "jane.doe@domain.com",
        "SupervisorRealname": "Jane Marianne Doe",
        "OperatorMailAddress": "jim.doe@domain.com",
        "OperatorRealname": "Jim Bob Doe",
        "BusinessModel": "AUTO",
        "SalesPersonIdentifier": "JDOE"
    }
}
Request data
String named MailAddress
String named Password
Response data
Object named JsonWebToken
Object named Actor

Resource: Authenticate, Method: invalidate

API service method providing actor unauthentication and JSON web token invalidation

Throws a NotAllowedException or a RequestException if invalidation fails. Exception codes have the following reasons:

  • 100310 Request is no JSON API request
  • 100311 Request is no PUT request
  • 100312 Request contains no valid JSON webtoken
Endpoint
PUT /core/api/v1/authenticate/invalidate/
Example request 
PUT /core/api/v1/authenticate/invalidate
Host: /
Accept: application/json
Content-Type: application/json
Content-Length: 98
{
    "JsonWebToken": "aHgxbjlpMTh3b3doczAzbDo4ODEwNzY0NC00MzE3LTRjY2ItYWE4MC0wYmQzYjkxOGZiYjQ="
}

HTTP/1.1 200 Ok
Date: Wed, 30 Sep 2020 12:55:39 +0000
Content-Length: 0
Content-Type: application/json
Request data
String named JsonWebToken

Resource: Authenticate, Method: test

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

Endpoint
GET /core/api/v1/authenticate/test/
Example request 
GET /core/api/v1/authenticate/test
Host: /
Accept: application/json
Authorization: Bearer aHgxbjlpMTh3b3doczAzbDo4ODEwNzY0NC00MzE3LTRjY2ItYWE4MC0wYmQzYjkxOGZiYjQ=

HTTP/1.1 200 Ok
Date: Wed, 30 Sep 2020 12:55:39 +0000
Content-Length: 22
Content-Type: application/json
{
    "Result": "ok"
}
Request header
Bearer JSON Web Token String named Authorization
Response data
String named Result

Resource: Authenticate, Method: head

Endpoint
HEAD /core/api/v1/authenticate/head/