Create an Endpoints Organization
media type | data type | description |
---|---|---|
application/json | EndpointsOrganizationRequest (JSON) | specify details for new Endpoints Organization |
media type | data type | description |
---|---|---|
application/json | EndpointsOrganizationDetails (JSON) | details of newly created Endpoints Organization |
POST /endpoints-organization
Content-Type: application/json
Accept: application/json
{
"name" : "...",
"licensedDevices" : 12345,
"licensedUsers" : 12345,
"active" : true
}
HTTP/1.1 201 Created
Content-Type: application/json
{
"guid" : "...",
"uuid" : "...",
"name" : "...",
"username" : "...",
"licensedUsers" : 12345,
"licensedDevices" : 12345,
"active" : true,
"admin" : {
"guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
"name" : "Entity name"
}
}
Returns list of Endpoints Organizations
media type | data type | description |
---|---|---|
application/json | array of EndpointsOrganizationDetails (JSON) | list of Endpoints Organizations |
GET /endpoints-organization/detailed
Content-Type: */*
Accept: application/json
...
HTTP/1.1 200 OK
Content-Type: application/json
[ {
"guid" : "...",
"uuid" : "...",
"name" : "...",
"username" : "...",
"licensedUsers" : 12345,
"licensedDevices" : 12345,
"active" : true,
"admin" : {
"guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
"name" : "Entity name"
}
} ]
Add an existing Endpoints Organization
media type | data type | description |
---|---|---|
application/json | ExistingEndpointsOrganizationRequest (JSON) | specify details for existing Endpoints Organization |
media type | data type | description |
---|---|---|
application/json | EndpointsOrganizationDetails (JSON) | details of endpoints Organization |
POST /endpoints-organization/existing
Content-Type: application/json
Accept: application/json
{
"username" : "...",
"password" : "..."
}
HTTP/1.1 201 Created
Content-Type: application/json
{
"guid" : "...",
"uuid" : "...",
"name" : "...",
"username" : "...",
"licensedUsers" : 12345,
"licensedDevices" : 12345,
"active" : true,
"admin" : {
"guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
"name" : "Entity name"
}
}
Remove Endpoints Organization
name | type | description |
---|---|---|
guid | path | specify local unique identifier for Endpoints Organization (use by vProtect) |
DELETE /endpoints-organization/{guid}
Content-Type: */*
...
HTTP/1.1 204 No Content
Get a single Endpoints Organization
name | type | description |
---|---|---|
guid | path | specify local unique identifier for Endpoints Organization (use by vProtect) |
media type | data type | description |
---|---|---|
application/json | EndpointsOrganizationDetails (JSON) | a single Endpoints Organization details |
GET /endpoints-organization/{guid}
Content-Type: */*
Accept: application/json
...
HTTP/1.1 200 OK
Content-Type: application/json
{
"guid" : "...",
"uuid" : "...",
"name" : "...",
"username" : "...",
"licensedUsers" : 12345,
"licensedDevices" : 12345,
"active" : true,
"admin" : {
"guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
"name" : "Entity name"
}
}
Change Endpoints Organization details.
name | type | description |
---|---|---|
guid | path | specify local unique identifier for Endpoints Organization (use by vProtect) |
media type | data type | description |
---|---|---|
application/json | EndpointsOrganizationRequest (JSON) | specify Endpoints Organization details to update |
media type | data type | description |
---|---|---|
application/json | EndpointsOrganizationDetails (JSON) | updated details of Endpoints Organization |
PUT /endpoints-organization/{guid}
Content-Type: application/json
Accept: application/json
{
"name" : "...",
"licensedDevices" : 12345,
"licensedUsers" : 12345,
"active" : true
}
HTTP/1.1 204 No Content
Content-Type: application/json
{
"guid" : "...",
"uuid" : "...",
"name" : "...",
"username" : "...",
"licensedUsers" : 12345,
"licensedDevices" : 12345,
"active" : true,
"admin" : {
"guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
"name" : "Entity name"
}
}