Endpoint Group Management

The Endpoint Group Management module is a software component that enables the management of groups of endpoints within a system. This module provides a user interface for adding, modifying, and deleting endpoint groups, as well as associating endpoint users with these groups.

To add endpoint users to an endpoint group, select the desired group from the Endpoint Group Management module and navigate to the Endpoint Users section. From here, you can add or remove users as necessary.

Once endpoint users have been added to an endpoint group, you can generate an authentication flow for the group. This authentication flow determines how users in the group will be authenticated when accessing resources and applications within the system.

List Endpoint Group

This lists all the Endpoint groups that are present. Endpoint groups refer to a collection of Linux endpoints.

curl --location --request POST https://api.authnull.kloudlearn.com/api/v1/instanceGroup/listEndpointGroup \
--header 'Content-Type: application/json' \
--data '{
  "domainId": "1",
  "filter": "",
  "pageId": 1,
  "pageSize": 100
}'

POST /api/v1/instanceGroup/listEndpointGroup

{
  "domainId": 1,
  "filter": "",
  "pageId": 1,
  "pageSize": 100
}

Access Token

Authorization Key Required

HTTP Request

POST /api/v1/instanceGroup/listEndpointGroup

Query Parameters

HTTP Response

{
  "totalCount": 2,
  "groups": [
    { "groupId": 60, "groupName": "test 5", "usersCount": 38 },
    { "groupId": 62, "groupName": "test1", "usersCount": 38 }
  ]
}

Add Endpoint Group

The Add Endpoint groups API allows users to add new Endpoint groups to a system or application.

curl --location --request POST https://api.authnull.kloudlearn.com/api/v1/instanceGroup/addInstanceGroup \
--header 'Content-Type: application/json' \
--data '{
  "domainId": 1,
  "instanceIds": [1, 3],
  "groupName": "ServerGroup",
  "ou": "",
  "cn": "",
  "dc": ""
}'

POST /api/v1/instanceGroup/addInstanceGroup

{
  "domainId": 1,
  "instanceIds": [1, 3],
  "groupName": "ServerGroup",
  "ou": "",
  "cn": "",
  "dc": ""
}

Access Token

Authorization Key Required

HTTP Request

POST /api/v1/instanceGroup/addInstanceGroup

Query Parameters

HTTP Response

{
  "instanceId": 63,
  "Code": "200",
  "Message": "Successfully Updated Endpoint Group"
}

Delete Endpoint Group

The Delete Endpoint Group API allows users to delete an existing Endpoint group from a system or application.

curl --location --request DELETE https://api.authnull.kloudlearn.com/api/v1/instanceGroup/deleteEndpointGroup \
--header 'Content-Type: application/json' \
--data '{
  "domainId": 2,
  "id": [555]
}'

DELETE /api/v1/instanceGroup/deleteEndpointGroup

{
  "domainId": 1,
  "id": 5
}

Access Token

Authorization Key Required

HTTP Request

DELETE /api/v1/instanceGroup/deleteEndpointGroup

Query Parameters

HTTP Response

{
  "status": "Success",
  "message": "Group Deleted successfully"
}

Edit Endpoint Group

The Edit Endpoint Group API allows users to modify an existing Endpoint group in a system or application.

curl --location --request PUT 'https://api.authnull.kloudlearn.com/api/v1/instanceGroup/editInstanceGroup' \
--header 'Content-Type: application/json' \
--data '{
  "domainId": 1,
  "instanceIds": [3, 5, 6],
  "groupName": "sefali",
  "groupId": 22
}'

PUT /api/v1/instanceGroup/editInstanceGroup

{
  "domainId": 16,
  "instanceIds": [1, 2],
  "groupName": "Ghimiray"
}

Access Token

Authorization Key Required

HTTP Request

PUT /api/v1/instanceGroup/editInstanceGroup

Query Parameters

HTTP Response

{
  "status": "Success",
  "message": "Status Updated Successfully"
}

Assign Users To Endpoint Group

The Assign Users to Endpoint Group API allows users to assign or add users to an existing Endpoint group.

curl --location 'https://api.authnull.kloudlearn.com/api/v1/instanceGroup/assignUsersToEndpointGroup' \
--header 'Content-Type: application/json' \
--data '{
  "domainId": 1234,
  "groupId": 9,
  "userIds": [2, 3],
  "action": "add"
}'

POST /api/v1/instances/assignUsersToEndpointGroup

{
  "domainId": 1234,
  "groupId": 9,
  "userIds": [2, 3],
  "action": "add"
}

Access Token

Authorization Key Required

HTTP Request

POST /api/v1/instances/assignUsersToEndpointGroup

Query Parameters

HTTP Response

{
  "status": "Success",
  "message": "Users Added/Removed successfully"
}

Add Auth Flow

The Add Authflow API allows users to add a new authentication flow to an existing Endpoint group.

curl --location 'https://api.authnull.kloudlearn.com/api/v1/instanceGroup/addAuthFlowToInstanceGroup' \
--header 'Content-Type: application/json' \
--data '{
  "domainId": 1234,
  "groupId": 13,
  "authFlow": "SSH,DID"
}'

POST /api/v1/instanceGroup/addAuthFlowToInstanceGroup

{
  "domainId": 1234,
  "groupId": 9,
  "authFlow": "SSH,DID"
}

Access Token

Authorization Key Required

HTTP Request

POST /api/v1/instanceGroup/addAuthFlowToInstanceGroup

Query Parameters

HTTP Response

{
  "instanceId": 13,
  "code": "200",
  "message": "Auth Flow Updated"
}

Update Instance Group Status

The Update Instance Group Status API allows users to update the status of an instance group.

curl --location --request PUT 'https://api.authnull.kloudlearn.com/api/v1/instanceGroup/updateInstanceGroupStatus' \
--header 'Content-Type: application/json' \
--data '{
  "domainId": 1234,
  "groupId": 9,
  "status": "Disabled"
}'

PUT /api/v1/instanceGroup/updateInstanceGroupStatus

{
  "domainId": 1234,
  "groupId": 9,
  "status": "Disabled"
}

Access Token

Authorization Key Required

HTTP Request

PUT /api/v1/instanceGroup/updateInstanceGroupStatus

Query Parameters

HTTP Response

{
  "status": "Success",
  "message": "Status Updated Successfully"
}