API introspection – List packages, resources and their interfaces

Found 6 resources

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

Skeleton service controller class

Interfaces

Found 4 interfaces in class Smartarchivo\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.

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 /core/api/v1/authenticate/actor/
Example request 
PUT /core/api/v1/authenticate/actor
Host: /
Accept: application/json
Content-Type: application/json
Content-Length: 78
Accept-Language: de-DE, de;q=0.9, en;q=0.8, fr;q=0.7, *;q=0.5
{
    "User": "john.doe@domain.com",
    "Password": "super secret password"
}

HTTP/1.1 200 Ok
Date: Tue, 24 Sep 2024 08:55:33 +0000
Content-Length: 1445
Content-Type: application/json
{
    "JsonWebToken": {
        "Token": "aHgxbjlpMTh3b3doczAzbDo4ODEwNzY0NC00MzE3LTRjY2ItYWE4MC0wYmQzYjkxOGZiYjQ=",
        "ValidUntil": 1591868066
    },
    "Actor": {
        "Uuid": "faeb338f-1ab5-4edc-ba59-90f5d0abcf52",
        "MailAddress": "john.doe@domain.com",
        "Username": "john.doe",
        "Realname": "John Archibald Doe"
    },
    "Clients": [
        {
            "Uuid": "2a6f2e13-c4f6-4a0f-9e9c-984d0c9e5da9",
            "Name": "Blackhawk Express",
            "ProductGroupNuclearMedicineSubscribed": true,
            "ProductGroupRadiologySubscribed": true,
            "ProductGroupWasteManagementSubscribed": true,
            "ProductGroupGenericSequencesSubscribed": true,
            "Facilities": [
                {
                    "Uuid": "c80c2ce0-df85-47d6-a460-5d9ccaa9c88e",
                    "Name": "Argo City",
                    "Permissions": [
                        "ACTOR_CREATE",
                        "ACTOR_UPDATE",
                        "ACTOR_UPDATEPERMISSIONS",
                        "ACTOR_ACTIVATE",
                        "ACTOR_LOCK",
                        "ACTOR_UNLOCK",
                        "ACTOR_DELETE",
                        "MEMBERSHIP_CREATE",
                        "MEMBERSHIP_UPDATE",
                        "MEMBERSHIP_DELETE",
                        "EVENT_STORE_VIEW"
                    ]
                }
            ]
        }
    ]
}
Request header
Acceptable Languages named Accept-Language // Optional
Request data
String named User    
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
Accept-Language: de-DE, de;q=0.9, en;q=0.8, fr;q=0.7, *;q=0.5
{
    "JsonWebToken": "aHgxbjlpMTh3b3doczAzbDo4ODEwNzY0NC00MzE3LTRjY2ItYWE4MC0wYmQzYjkxOGZiYjQ="
}

HTTP/1.1 200 Ok
Date: Tue, 24 Sep 2024 08:55:33 +0000
Content-Length: 0
Content-Type: application/json
Request header
Acceptable Languages named Accept-Language // Optional
Request data
String named JsonWebToken

Resource: Authenticate, Method: fileDownloadToken

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

Endpoint
GET /core/api/v1/authenticate/file-download-token/
Example request 
GET /core/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:33 +0000
Content-Length: 67
Content-Type: application/json
{
    "FileDownloadToken": "123e4567-e89b-12d3-a456-426655440000"
}
Request header
Acceptable Languages named Accept-Language // Optional
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 /core/api/v1/authenticate/test/
Example request 
GET /core/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:33 +0000
Content-Length: 22
Content-Type: application/json
{
    "Result": "ok"
}
Request header
Acceptable Languages named Accept-Language // Optional
Bearer JSON Web Token String named Authorization
Response data
String named Result