SecurityZoneREST Resource

GET /zones/zones

Response Body
media type data type description
application/json RangerSecurityZoneList (JSON)
application/xml rangerSecurityZoneList (XML)

Example

Request
GET /zones/zones
Content-Type: */*
Accept: application/json

                
...
Response
HTTP/1.1 200 OK
Content-Type: application/json

                
{
  "securityZones" : [ {
    "tagServices" : [ "...", "..." ],
    "description" : "...",
    "auditUsers" : [ "...", "..." ],
    "adminUserGroups" : [ "...", "..." ],
    "adminUsers" : [ "...", "..." ],
    "name" : "...",
    "services" : {
      "property1" : {
        "resources" : [ {
          "property1" : [ ],
          "property2" : [ ]
        }, {
          "property1" : [ ],
          "property2" : [ ]
        } ]
      },
      "property2" : {
        "resources" : [ {
          "property1" : [ ],
          "property2" : [ ]
        }, {
          "property1" : [ ],
          "property2" : [ ]
        } ]
      }
    },
    "auditUserGroups" : [ "...", "..." ],
    "createTime" : 12345,
    "id" : 12345,
    "updatedBy" : "...",
    "version" : 12345,
    "createdBy" : "...",
    "guid" : "...",
    "updateTime" : 12345,
    "isEnabled" : true
  }, {
    "tagServices" : [ "...", "..." ],
    "description" : "...",
    "auditUsers" : [ "...", "..." ],
    "adminUserGroups" : [ "...", "..." ],
    "adminUsers" : [ "...", "..." ],
    "name" : "...",
    "services" : {
      "property1" : {
        "resources" : [ {
          "property1" : [ ],
          "property2" : [ ]
        }, {
          "property1" : [ ],
          "property2" : [ ]
        } ]
      },
      "property2" : {
        "resources" : [ {
          "property1" : [ ],
          "property2" : [ ]
        }, {
          "property1" : [ ],
          "property2" : [ ]
        } ]
      }
    },
    "auditUserGroups" : [ "...", "..." ],
    "createTime" : 12345,
    "id" : 12345,
    "updatedBy" : "...",
    "version" : 12345,
    "createdBy" : "...",
    "guid" : "...",
    "updateTime" : 12345,
    "isEnabled" : true
  } ],
  "listSize" : 12345,
  "list" : [ { }, { } ],
  "startIndex" : 12345,
  "pageSize" : 12345,
  "totalCount" : 12345,
  "resultSize" : 12345,
  "sortType" : "...",
  "sortBy" : "..."
}

POST /zones/zones

Request Body
media type data type
application/json RangerSecurityZone (JSON)
application/xml rangerSecurityZone (XML)
Response Body
media type data type description
application/json RangerSecurityZone (JSON)
application/xml rangerSecurityZone (XML)

Example

Request
POST /zones/zones
Content-Type: application/json
Accept: application/json

                
{
  "tagServices" : [ "...", "..." ],
  "description" : "...",
  "auditUsers" : [ "...", "..." ],
  "adminUserGroups" : [ "...", "..." ],
  "adminUsers" : [ "...", "..." ],
  "name" : "...",
  "services" : {
    "property1" : {
      "resources" : [ {
        "property1" : [ ],
        "property2" : [ ]
      }, {
        "property1" : [ ],
        "property2" : [ ]
      } ]
    },
    "property2" : {
      "resources" : [ {
        "property1" : [ ],
        "property2" : [ ]
      }, {
        "property1" : [ ],
        "property2" : [ ]
      } ]
    }
  },
  "auditUserGroups" : [ "...", "..." ],
  "createTime" : 12345,
  "id" : 12345,
  "updatedBy" : "...",
  "version" : 12345,
  "createdBy" : "...",
  "guid" : "...",
  "updateTime" : 12345,
  "isEnabled" : true
}
Response
HTTP/1.1 201 Created
Content-Type: application/json

                
{
  "tagServices" : [ "...", "..." ],
  "description" : "...",
  "auditUsers" : [ "...", "..." ],
  "adminUserGroups" : [ "...", "..." ],
  "adminUsers" : [ "...", "..." ],
  "name" : "...",
  "services" : {
    "property1" : {
      "resources" : [ {
        "property1" : [ ],
        "property2" : [ ]
      }, {
        "property1" : [ ],
        "property2" : [ ]
      } ]
    },
    "property2" : {
      "resources" : [ {
        "property1" : [ ],
        "property2" : [ ]
      }, {
        "property1" : [ ],
        "property2" : [ ]
      } ]
    }
  },
  "auditUserGroups" : [ "...", "..." ],
  "createTime" : 12345,
  "id" : 12345,
  "updatedBy" : "...",
  "version" : 12345,
  "createdBy" : "...",
  "guid" : "...",
  "updateTime" : 12345,
  "isEnabled" : true
}

DELETE /zones/zones/{id}

Request Parameters
name type description constraints
id path long

Example

Request
DELETE /zones/zones/{id}
Content-Type: */*

                
...
Response
HTTP/1.1 204 No Content

GET /zones/zones/{id}

Request Parameters
name type description constraints
id path long
Response Body
media type data type description
application/json RangerSecurityZone (JSON)
application/xml rangerSecurityZone (XML)

Example

Request
GET /zones/zones/{id}
Content-Type: */*
Accept: application/json

                
...
Response
HTTP/1.1 200 OK
Content-Type: application/json

                
{
  "tagServices" : [ "...", "..." ],
  "description" : "...",
  "auditUsers" : [ "...", "..." ],
  "adminUserGroups" : [ "...", "..." ],
  "adminUsers" : [ "...", "..." ],
  "name" : "...",
  "services" : {
    "property1" : {
      "resources" : [ {
        "property1" : [ ],
        "property2" : [ ]
      }, {
        "property1" : [ ],
        "property2" : [ ]
      } ]
    },
    "property2" : {
      "resources" : [ {
        "property1" : [ ],
        "property2" : [ ]
      }, {
        "property1" : [ ],
        "property2" : [ ]
      } ]
    }
  },
  "auditUserGroups" : [ "...", "..." ],
  "createTime" : 12345,
  "id" : 12345,
  "updatedBy" : "...",
  "version" : 12345,
  "createdBy" : "...",
  "guid" : "...",
  "updateTime" : 12345,
  "isEnabled" : true
}

PUT /zones/zones/{id}

Request Parameters
name type description constraints
id path long
Request Body
media type data type
application/json RangerSecurityZone (JSON)
application/xml rangerSecurityZone (XML)
Response Body
media type data type description
application/json RangerSecurityZone (JSON)
application/xml rangerSecurityZone (XML)

Example

Request
PUT /zones/zones/{id}
Content-Type: application/json
Accept: application/json

                
{
  "tagServices" : [ "...", "..." ],
  "description" : "...",
  "auditUsers" : [ "...", "..." ],
  "adminUserGroups" : [ "...", "..." ],
  "adminUsers" : [ "...", "..." ],
  "name" : "...",
  "services" : {
    "property1" : {
      "resources" : [ {
        "property1" : [ ],
        "property2" : [ ]
      }, {
        "property1" : [ ],
        "property2" : [ ]
      } ]
    },
    "property2" : {
      "resources" : [ {
        "property1" : [ ],
        "property2" : [ ]
      }, {
        "property1" : [ ],
        "property2" : [ ]
      } ]
    }
  },
  "auditUserGroups" : [ "...", "..." ],
  "createTime" : 12345,
  "id" : 12345,
  "updatedBy" : "...",
  "version" : 12345,
  "createdBy" : "...",
  "guid" : "...",
  "updateTime" : 12345,
  "isEnabled" : true
}
Response
HTTP/1.1 204 No Content
Content-Type: application/json

                
{
  "tagServices" : [ "...", "..." ],
  "description" : "...",
  "auditUsers" : [ "...", "..." ],
  "adminUserGroups" : [ "...", "..." ],
  "adminUsers" : [ "...", "..." ],
  "name" : "...",
  "services" : {
    "property1" : {
      "resources" : [ {
        "property1" : [ ],
        "property2" : [ ]
      }, {
        "property1" : [ ],
        "property2" : [ ]
      } ]
    },
    "property2" : {
      "resources" : [ {
        "property1" : [ ],
        "property2" : [ ]
      }, {
        "property1" : [ ],
        "property2" : [ ]
      } ]
    }
  },
  "auditUserGroups" : [ "...", "..." ],
  "createTime" : 12345,
  "id" : 12345,
  "updatedBy" : "...",
  "version" : 12345,
  "createdBy" : "...",
  "guid" : "...",
  "updateTime" : 12345,
  "isEnabled" : true
}

DELETE /zones/zones/name/{name}

Request Parameters
name type description
name path

Example

Request
DELETE /zones/zones/name/{name}
Content-Type: */*

                
...
Response
HTTP/1.1 204 No Content

GET /zones/zones/name/{name}

Request Parameters
name type description
name path
Response Body
media type data type description
application/json RangerSecurityZone (JSON)
application/xml rangerSecurityZone (XML)

Example

Request
GET /zones/zones/name/{name}
Content-Type: */*
Accept: application/json

                
...
Response
HTTP/1.1 200 OK
Content-Type: application/json

                
{
  "tagServices" : [ "...", "..." ],
  "description" : "...",
  "auditUsers" : [ "...", "..." ],
  "adminUserGroups" : [ "...", "..." ],
  "adminUsers" : [ "...", "..." ],
  "name" : "...",
  "services" : {
    "property1" : {
      "resources" : [ {
        "property1" : [ ],
        "property2" : [ ]
      }, {
        "property1" : [ ],
        "property2" : [ ]
      } ]
    },
    "property2" : {
      "resources" : [ {
        "property1" : [ ],
        "property2" : [ ]
      }, {
        "property1" : [ ],
        "property2" : [ ]
      } ]
    }
  },
  "auditUserGroups" : [ "...", "..." ],
  "createTime" : 12345,
  "id" : 12345,
  "updatedBy" : "...",
  "version" : 12345,
  "createdBy" : "...",
  "guid" : "...",
  "updateTime" : 12345,
  "isEnabled" : true
}