Get Group Struct

The "Get Group Struct" endpoint return the structure of parameters of specified Group

Headers

KeyValue
arke-project-key<YOUR_PROJECT_ID>
AuthorizationBearer <ACCESS_TOKEN>
content-typeapplication/json

HTTP Response status

Status codeDescription
200OK
401Unauthorized
403Forbidden
500Internal server error
Code samples for "Get Group Struct"
GET
/api/lib/group/{group_id}/struct
curl --location 'https://arkehub.com/api/lib/group/{group_id}/struct' \
-H "Arke-Project-Key: <YOUR_PROJECT_ID>" \
-H "Authorization: <ACCESS_TOKEN>" \
-H 'Content-Type: application/json' \
Response with Group struct
"content": {
    "label": "Arke auth member",
    "parameters": [
    {
        "default": null,
        "helper_text": null,
        "id": "email",
        "label": "Email",
        "max_length": 50,
        "min_length": 0,
        "multiple": false,
        "required": false,
        "strip": false,
        "type": "string",
        "values": null
    },
    ...
    ]
},
    "messages": []
}

Get All Arke of Group

The "Get All Arke of Group" endpoint return the list of all available arke inside the group

Headers

KeyValue
arke-project-key<YOUR_PROJECT_ID>
AuthorizationBearer <ACCESS_TOKEN>
content-typeapplication/json

HTTP Response status

Status codeDescription
200OK
401Unauthorized
403Forbidden
500Internal server error
Code samples for "Get All Arke of Group"
GET
/api/lib/group/{group_id}/arke
curl --location 'https://arkehub.com/api/lib/group/{group_id}/arke' \
-H "Arke-Project-Key: <YOUR_PROJECT_ID>" \
-H "Authorization: <ACCESS_TOKEN>" \
-H 'Content-Type: application/json' \
Response with Arke list in the group
{
    "content": {
        "count": 5,
        "items": [
            {
                "active": true,
                "arke_id": "arke",
                "id": "super_admin",
                "inserted_at": "2023-09-14T10:03:48.000000Z",
                "label": "Super Admin",
                "metadata": {},
                "parameters": [],
                "remote": false,
                "type": "arke",
                "updated_at": "2023-09-14T10:03:48.000000Z"
            },
            ...
        ]
    },
    "messages": []
}

Get All Units of Group

The "Get All Units of Group" endpoint return the list of all available units inside the group

Headers

KeyValue
arke-project-key<YOUR_PROJECT_ID>
AuthorizationBearer <ACCESS_TOKEN>
content-typeapplication/json

HTTP Response status

Status codeDescription
200OK
401Unauthorized
403Forbidden
500Internal server error
Code samples for "Get All Arke of Group"
GET
/api/lib/group/{group_id}/unit
curl --location 'https://arkehub.com/api/lib/group/{group_id}/unit' \
-H "Arke-Project-Key: <YOUR_PROJECT_ID>" \
-H "Authorization: <ACCESS_TOKEN>" \
    -H 'Content-Type: application/json' \
Response with Unit list in the group
{
    "content": {
        {
            "arke_id": "super_admin",
            "arke_system_user": "c2e3b048-1a6a-11ee-908c-1a84faf9f6ef",
            "business_name": "Arke",
            "email": "user@arkehub.com",
            "id": "824135a6-52e6-11ee-9387-96e316d04b51",
            "last_access_time": "2024-04-04T15:39:48.501632Z",
            "last_name": "Super",
            "metadata": {},
            "phone": "123123123",
            "postal_code": null,
            "updated_at": "2024-04-04T15:39:49.000000Z",
            "vat": "123123123"
        },
    },
        "messages": []
    }
}

Get Unit in a Group

The "Get Unit in a Group" endpoint return details of the specified unit in the group

Headers

KeyValue
arke-project-key<YOUR_PROJECT_ID>
AuthorizationBearer <ACCESS_TOKEN>
content-typeapplication/json

HTTP Response status

Status codeDescription
200OK
401Unauthorized
403Forbidden
500Internal server error
Code samples for "Get Unit in a Group"
GET
/api/lib//group/{group_id}/unit/{unit_id}
curl --location 'https://arkehub.com/api/lib/group/{group_id}/unit/{unit_id}' \
-H "Arke-Project-Key: <YOUR_PROJECT_ID>" \
-H "Authorization: <ACCESS_TOKEN>" \
-H 'Content-Type: application/json' \
Response with Unit details of group
{
    "content": {
        {
            "active": true,
            "arke_id": "arke",
            "id": "super_admin",
            "inserted_at": "2023-09-14T10:03:48.000000Z",
            "label": "Super Admin",
            "metadata": {},
            "parameters": [],
            "remote": false,
            "type": "arke",
            "updated_at": "2023-09-14T10:03:48.000000Z"
        },
    },
    "messages": []
}

Create Group

The "Create Group" endpoint create a Group with the specified information

Headers

KeyValue
arke-project-key<YOUR_PROJECT_ID>
AuthorizationBearer <ACCESS_TOKEN>
content-typeapplication/json

Body

KeyValue
<PARAMETER_ID><VALUE>
<PARAMETER_ID_2><VALUE>
<PARAMETER_ID_3><VALUE>

HTTP Response status

Status codeDescription
200OK
401Unauthorized
403Forbidden
500Internal server error
Code samples for "Create Group"
POST
/api/lib/group/unit
curl --location 'https://arkehub.com/api/lib/group/unit' \
-H "Arke-Project-Key: <YOUR_PROJECT_ID>" \
-H "Authorization: <ACCESS_TOKEN>" \
    -H 'Content-Type: application/json' \
Response with Group details created
{
    "content": {
        "arke_id": "group",
        "arke_list": ["arke_1","arke_2"],
        "description": "Group",
        "id": "docs_group",
        "inserted_at": "2024-04-04T17:11:41Z",
        "label": "Group docs",
        "metadata": {},
        "updated_at": "2024-04-04T17:11:41Z"
    },
    "messages": []
}

Edit Group

The "Edit Group" endpoint update the specified Group information

Headers

KeyValue
arke-project-key<YOUR_PROJECT_ID>
AuthorizationBearer <ACCESS_TOKEN>
content-typeapplication/json

Body

KeyValue
<PARAMETER_ID><NEW_VALUE>

HTTP Response status

Status codeDescription
200OK
401Unauthorized
403Forbidden
500Internal server error
Code samples for "Edit Group"
PUT
/api/lib/group/unit/{group_id}
curl --location 'https://arkehub.com/api/lib/group/unit/{group_id}' \
-H "Arke-Project-Key: <YOUR_PROJECT_ID>" \
-H "Authorization: <ACCESS_TOKEN>" \
    -H 'Content-Type: application/json' \
Response with Group details updated
{
    "content": {
    "arke_id": "group",
    "arke_list": ["arke_1","arke_2"],
    "description": "Edited Group",
    "id": "docs_group",
    "inserted_at": "2024-04-04T17:11:41Z",
    "label": "Edited Group docs",
    "metadata": {},
    "updated_at": "2024-04-04T17:11:41Z"
},
    "messages": []
}

Delete Group

The "Delete Group" endpoint delete the specified group

Headers

KeyValue
arke-project-key<YOUR_PROJECT_ID>
AuthorizationBearer <ACCESS_TOKEN>
content-typeapplication/json

HTTP Response status

Status codeDescription
204OK
401Unauthorized
500Internal server error
Code samples for "Delete Group"
DELETE
/api/lib/group/unit/{group_id}
curl --location 'https://arkehub.com/api/lib/group/unit/{group_id}' \
-H "Arke-Project-Key: <YOUR_PROJECT_ID>" \
-H "Authorization: <ACCESS_TOKEN>" \
-H 'Content-Type: application/json' \
Response with no content
{
    "content": null,
    "messages": []
}

Add Arke in a Group

The "Add Arke in a Group" endpoint create an association link between specified Arke and Group

HTTP Response status

Status codeDescription
200OK
401Unauthorized
403Forbidden
500Internal server error
Code samples for "Add Arke in a Group"
POST
/group/unit/{group_id}/link/group/arke/unit/{arke_id}
curl --location 'https://arkehub.com/api/lib/group/unit/{group_id}/link/group/arke/unit/{arke_id}' \
-H "Arke-Project-Key: <YOUR_PROJECT_ID>" \
-H "Authorization: <ACCESS_TOKEN>" \
-H 'Content-Type: application/json' \
Response with Arke associated on group
{
    "content": {
        {
            "active": true,
            "arke_id": "arke",
            "id": "my_arke",
            "inserted_at": "2023-09-14T10:03:48.000000Z",
            "label": "My Arke",
            "metadata": {},
            "parameters": [],
            "remote": false,
            "type": "arke",
            "updated_at": "2023-09-14T10:03:48.000000Z"
        },
    },
    "messages": []
}

Remove Arke in a Group

The "Remove Arke in a Group" endpoint remove the specified arke in a group

Headers

KeyValue
arke-project-key<YOUR_PROJECT_ID>
AuthorizationBearer <ACCESS_TOKEN>
content-typeapplication/json

HTTP Response status

Status codeDescription
200OK
401Unauthorized
403Forbidden
500Internal server error
Code samples for "Remove Arke in a Group"
DELETE
/group/unit/{group_id}/link/group/arke/unit/{arke_id}
curl --location 'https://arkehub.com/api/lib/group/unit/{group_id}/link/group/arke/unit/{arke_id}' \
-H "Arke-Project-Key: <YOUR_PROJECT_ID>" \
-H "Authorization: <ACCESS_TOKEN>" \
-H 'Content-Type: application/json' \
Response with no content
{
    "content": null,
    "messages": []
}
LinkOffset & limit