Endpoints Organization Controller Resource

POST /endpoints-organization

Create an Endpoints Organization

Request Body
media type data type description
application/json EndpointsOrganizationRequest (JSON) specify details for new Endpoints Organization
Response Body
media type data type description
application/json EndpointsOrganizationDetails (JSON) details of newly created Endpoints Organization

Example

Request
POST /endpoints-organization
Content-Type: application/json
Accept: application/json

                
{
  "name" : "...",
  "licensedDevices" : 12345,
  "licensedUsers" : 12345,
  "active" : true
}
                
              
Response
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"
  }
}
                
              

GET /endpoints-organization/detailed

Returns list of Endpoints Organizations

Response Body
media type data type description
application/json array of EndpointsOrganizationDetails (JSON) list of Endpoints Organizations

Example

Request
GET /endpoints-organization/detailed
Content-Type: */*
Accept: application/json

                
...
                
              
Response
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"
  }
} ]
                
              

POST /endpoints-organization/existing

Add an existing Endpoints Organization

Request Body
media type data type description
application/json ExistingEndpointsOrganizationRequest (JSON) specify details for existing Endpoints Organization
Response Body
media type data type description
application/json EndpointsOrganizationDetails (JSON) details of endpoints Organization

Example

Request
POST /endpoints-organization/existing
Content-Type: application/json
Accept: application/json

                
{
  "username" : "...",
  "password" : "..."
}
                
              
Response
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"
  }
}
                
              

DELETE /endpoints-organization/{guid}

Remove Endpoints Organization

Request Parameters
name type description
guid path specify local unique identifier for Endpoints Organization (use by vProtect)

Example

Request
DELETE /endpoints-organization/{guid}
Content-Type: */*

                
...
                
              
Response
HTTP/1.1 204 No Content

              

GET /endpoints-organization/{guid}

Get a single Endpoints Organization

Request Parameters
name type description
guid path specify local unique identifier for Endpoints Organization (use by vProtect)
Response Body
media type data type description
application/json EndpointsOrganizationDetails (JSON) a single Endpoints Organization details

Example

Request
GET /endpoints-organization/{guid}
Content-Type: */*
Accept: application/json

                
...
                
              
Response
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"
  }
}
                
              

PUT /endpoints-organization/{guid}

Change Endpoints Organization details.

Request Parameters
name type description
guid path specify local unique identifier for Endpoints Organization (use by vProtect)
Request Body
media type data type description
application/json EndpointsOrganizationRequest (JSON) specify Endpoints Organization details to update
Response Body
media type data type description
application/json EndpointsOrganizationDetails (JSON) updated details of Endpoints Organization

Example

Request
PUT /endpoints-organization/{guid}
Content-Type: application/json
Accept: application/json

                
{
  "name" : "...",
  "licensedDevices" : 12345,
  "licensedUsers" : 12345,
  "active" : true
}
                
              
Response
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"
  }
}