API introspection – List packages, resources and their interfaces

Found 4 resources

Resource class ContentVendor\Extension\AuthProvider\Controller\Api\V1\ClientActorController of type EntityController
Access controlled by ContentVendor\Core\Api\AccessRule\ApiAccessRule, ContentVendor\Extension\AuthProvider\Core\Api\AccessRule\ClientActorApiAccessRule

Skeleton class for controlling a row from the 'ClientActorModel' table.

Controller providing client actor related collection actions.

Name Type Size Default Description Visible Mutable Nullable
MailAddress VARCHAR 128 not set yes no no
Username VARCHAR 128 not set yes yes no
Password VARCHAR 64 not set no yes no
Realname VARCHAR 128 not set yes yes no
CreatedAt TIMESTAMP not set yes no yes
UpdatedAt TIMESTAMP not set yes no yes
Uuid VARCHAR 36 not set yes no no

Interfaces

Found 2 interfaces in class ContentVendor\Extension\AuthProvider\Controller\Api\V1\ClientActorController

Resource: ClientActor, Method: load

Loads a model enitiy from the table defined by the model class name

Endpoint
GET /auth-provider/api/v1/client-actor/{uuid}/
Example request 
GET /auth-provider/api/v1/client-actor/{uuid}
Host: /
Accept: application/json
Authorization: Bearer aHgxbjlpMTh3b3doczAzbDo4ODEwNzY0NC00MzE3LTRjY2ItYWE4MC0wYmQzYjkxOGZiYjQ=

HTTP/1.1 200 Ok
Date: Sat, 15 Feb 2020 13:48:49 +0000
Content-Length: 812
Content-Type: application/json
{
    "ClientActorModel": {
        "Username": "jdoe",
        "MailAddress": "john.doe@mail.com",
        "Realname": "John Doe",
        "CreatedAt": "2013-11-12 16:39:00",
        "UpdatedAt": "2013-11-12 16:39:00",
        "Uuid": "123e4567-e89b-12d3-a456-426655440000"
    },
    "Notifications": [
        {
            "Type": "Propeller\\Lib\\ControllerNotification\\ControllerNotification",
            "Message": "SOME_NOTIFICATION_MESSAGE",
            "LocalizedMessage": "The localized notification message",
            "Level": 1,
            "LevelAsString": "notification",
            "Details": [
                "Localized detail message #1",
                "Localized detail message #2",
                "Localized detail message #3"
            ],
            "Code": 17
        }
    ]
}
GET /auth-provider/api/v1/client-actor/{uuid}
                      

                      Host: /                      

                      Accept: application/json
                                                                                              

                          Authorization: Bearer aHgxbjlpMTh3b3doczAzbDo4ODEwNzY0NC00MzE3LTRjY2ItYWE4MC0wYmQzYjkxOGZiYjQ=                                              
                                            

                      

                      

                      HTTP/1.1 200 Ok
                      

                      Date: Sat, 15 Feb 2020 13:48:49 +0000                      

                      Content-Length: 812                      

                      Content-Type: application/json
                                              

                        {
    "ClientActorModel": {
        "Username": "jdoe",
        "MailAddress": "john.doe@mail.com",
        "Realname": "John Doe",
        "CreatedAt": "2013-11-12 16:39:00",
        "UpdatedAt": "2013-11-12 16:39:00",
        "Uuid": "123e4567-e89b-12d3-a456-426655440000"
    },
    "Notifications": [
        {
            "Type": "Propeller\\Lib\\ControllerNotification\\ControllerNotification",
            "Message": "SOME_NOTIFICATION_MESSAGE",
            "LocalizedMessage": "The localized notification message",
            "Level": 1,
            "LevelAsString": "notification",
            "Details": [
                "Localized detail message #1",
                "Localized detail message #2",
                "Localized detail message #3"
            ],
            "Code": 17
        }
    ]
}
Request header
Bearer Token named Authorization
Response data
FilteredClientActorControllerModel named ClientActorModel

Resource: ClientActor, Method: update

Updates model with properties given by request

Endpoint
PUT /auth-provider/api/v1/client-actor/{Uuid}/
Example request 
PUT /auth-provider/api/v1/client-actor/{Uuid}
Host: /
Accept: application/json
Content-Type: application/json
Content-Length: 88
Authorization: Bearer aHgxbjlpMTh3b3doczAzbDo4ODEwNzY0NC00MzE3LTRjY2ItYWE4MC0wYmQzYjkxOGZiYjQ=
{
    "Username": "jdoe",
    "Realname": "John Doe",
    "Password": "bestkeptsecret"
}

HTTP/1.1 200 Ok
Date: Sat, 15 Feb 2020 13:48:49 +0000
Content-Length: 812
Content-Type: application/json
{
    "ClientActorModel": {
        "Username": "jdoe",
        "MailAddress": "john.doe@mail.com",
        "Realname": "John Doe",
        "CreatedAt": "2013-11-12 16:39:00",
        "UpdatedAt": "2013-11-12 16:39:00",
        "Uuid": "123e4567-e89b-12d3-a456-426655440000"
    },
    "Notifications": [
        {
            "Type": "Propeller\\Lib\\ControllerNotification\\ControllerNotification",
            "Message": "SOME_NOTIFICATION_MESSAGE",
            "LocalizedMessage": "The localized notification message",
            "Level": 1,
            "LevelAsString": "notification",
            "Details": [
                "Localized detail message #1",
                "Localized detail message #2",
                "Localized detail message #3"
            ],
            "Code": 17
        }
    ]
}
PUT /auth-provider/api/v1/client-actor/{Uuid}
                      

                      Host: /                      

                      Accept: application/json
                                              

                        Content-Type: application/json
                        

                        Content-Length: 88                                                                                              

                          Authorization: Bearer aHgxbjlpMTh3b3doczAzbDo4ODEwNzY0NC00MzE3LTRjY2ItYWE4MC0wYmQzYjkxOGZiYjQ=                                              
                                              

                        {
    "Username": "jdoe",
    "Realname": "John Doe",
    "Password": "bestkeptsecret"
}
                                            

                      

                      

                      HTTP/1.1 200 Ok
                      

                      Date: Sat, 15 Feb 2020 13:48:49 +0000                      

                      Content-Length: 812                      

                      Content-Type: application/json
                                              

                        {
    "ClientActorModel": {
        "Username": "jdoe",
        "MailAddress": "john.doe@mail.com",
        "Realname": "John Doe",
        "CreatedAt": "2013-11-12 16:39:00",
        "UpdatedAt": "2013-11-12 16:39:00",
        "Uuid": "123e4567-e89b-12d3-a456-426655440000"
    },
    "Notifications": [
        {
            "Type": "Propeller\\Lib\\ControllerNotification\\ControllerNotification",
            "Message": "SOME_NOTIFICATION_MESSAGE",
            "LocalizedMessage": "The localized notification message",
            "Level": 1,
            "LevelAsString": "notification",
            "Details": [
                "Localized detail message #1",
                "Localized detail message #2",
                "Localized detail message #3"
            ],
            "Code": 17
        }
    ]
}
Request header
Bearer Token named Authorization
Request data
FilteredClientActorControllerModel
Response data
FilteredClientActorControllerModel named ClientActorModel