Ranger REST API: SecurityZoneREST

GET /zones/summary

Response Body
media type	data type	description
application/json	PListOfSecurityZoneSummary (JSON)

Example

Request

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

                
...

Response

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

                
{
  "queryTimeMS" : 12345,
  "sortType" : "...",
  "resultSize" : 12345,
  "sortBy" : "...",
  "pageSize" : 12345,
  "startIndex" : 12345,
  "listSize" : 12345,
  "list" : [ {
    "description" : "...",
    "auditorCount" : {
      "property1" : 12345,
      "property2" : 12345
    },
    "services" : [ {
      "id" : 12345,
      "displayName" : "...",
      "resourceCount" : 12345,
      "name" : "...",
      "type" : "..."
    }, {
      "id" : 12345,
      "displayName" : "...",
      "resourceCount" : 12345,
      "name" : "...",
      "type" : "..."
    } ],
    "totalResourceCount" : 12345,
    "adminCount" : {
      "property1" : 12345,
      "property2" : 12345
    },
    "name" : "...",
    "tagServices" : [ "...", "..." ],
    "createdBy" : "...",
    "createTime" : 12345,
    "id" : 12345,
    "version" : 12345,
    "isEnabled" : true,
    "guid" : "...",
    "updateTime" : 12345,
    "updatedBy" : "..."
  }, {
    "description" : "...",
    "auditorCount" : {
      "property1" : 12345,
      "property2" : 12345
    },
    "services" : [ {
      "id" : 12345,
      "displayName" : "...",
      "resourceCount" : 12345,
      "name" : "...",
      "type" : "..."
    }, {
      "id" : 12345,
      "displayName" : "...",
      "resourceCount" : 12345,
      "name" : "...",
      "type" : "..."
    } ],
    "totalResourceCount" : 12345,
    "adminCount" : {
      "property1" : 12345,
      "property2" : 12345
    },
    "name" : "...",
    "tagServices" : [ "...", "..." ],
    "createdBy" : "...",
    "createTime" : 12345,
    "id" : 12345,
    "version" : 12345,
    "isEnabled" : true,
    "guid" : "...",
    "updateTime" : 12345,
    "updatedBy" : "..."
  } ],
  "totalCount" : 12345
}

GET /zones/zones

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

Example

Request

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

                
...

Response

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

                
{
  "securityZones" : [ {
    "adminUserGroups" : [ "...", "..." ],
    "auditUsers" : [ "...", "..." ],
    "adminUsers" : [ "...", "..." ],
    "name" : "...",
    "adminRoles" : [ "...", "..." ],
    "auditRoles" : [ "...", "..." ],
    "tagServices" : [ "...", "..." ],
    "services" : {
      "property1" : {
        "resourcesBaseInfo" : [ { }, { } ],
        "resources" : [ {
          "property1" : [ "...", "..." ],
          "property2" : [ "...", "..." ]
        }, {
          "property1" : [ "...", "..." ],
          "property2" : [ "...", "..." ]
        } ]
      },
      "property2" : {
        "resourcesBaseInfo" : [ { }, { } ],
        "resources" : [ {
          "property1" : [ "...", "..." ],
          "property2" : [ "...", "..." ]
        }, {
          "property1" : [ "...", "..." ],
          "property2" : [ "...", "..." ]
        } ]
      }
    },
    "description" : "...",
    "auditUserGroups" : [ "...", "..." ],
    "createdBy" : "...",
    "createTime" : 12345,
    "id" : 12345,
    "version" : 12345,
    "isEnabled" : true,
    "guid" : "...",
    "updateTime" : 12345,
    "updatedBy" : "..."
  }, {
    "adminUserGroups" : [ "...", "..." ],
    "auditUsers" : [ "...", "..." ],
    "adminUsers" : [ "...", "..." ],
    "name" : "...",
    "adminRoles" : [ "...", "..." ],
    "auditRoles" : [ "...", "..." ],
    "tagServices" : [ "...", "..." ],
    "services" : {
      "property1" : {
        "resourcesBaseInfo" : [ { }, { } ],
        "resources" : [ {
          "property1" : [ "...", "..." ],
          "property2" : [ "...", "..." ]
        }, {
          "property1" : [ "...", "..." ],
          "property2" : [ "...", "..." ]
        } ]
      },
      "property2" : {
        "resourcesBaseInfo" : [ { }, { } ],
        "resources" : [ {
          "property1" : [ "...", "..." ],
          "property2" : [ "...", "..." ]
        }, {
          "property1" : [ "...", "..." ],
          "property2" : [ "...", "..." ]
        } ]
      }
    },
    "description" : "...",
    "auditUserGroups" : [ "...", "..." ],
    "createdBy" : "...",
    "createTime" : 12345,
    "id" : 12345,
    "version" : 12345,
    "isEnabled" : true,
    "guid" : "...",
    "updateTime" : 12345,
    "updatedBy" : "..."
  } ],
  "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)

Response Body
media type	data type	description
application/json	RangerSecurityZone (JSON)

Example

Request

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

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

Response

HTTP/1.1 201 Created
Content-Type: application/json

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

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)

Example

Request

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

                
...

Response

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

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

PUT /zones/zones/{id}

Request Parameters
name	type	description	constraints
id	path		long

Request Body
media type	data type
application/json	RangerSecurityZone (JSON)

Response Body
media type	data type	description
application/json	RangerSecurityZone (JSON)

Example

Request

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

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

Response

HTTP/1.1 204 No Content
Content-Type: application/json

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

GET /zones/zone-names/{serviceName}/resource

Request Parameters
name	type	description
serviceName	path

Response Body
media type	data type	description
application/json	array of string (JSON)

Example

Request

GET /zones/zone-names/{serviceName}/resource
Content-Type: */*
Accept: application/json

                
...

Response

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

                
...

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)

Example

Request

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

                
...

Response

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

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

GET /zones/zones/zone-headers/for-service/{serviceId}

Request Parameters
name	type	description	default	constraints
serviceId	path			long
isTagService	query		false	boolean

Response Body
media type	data type	description
application/json	array of RangerSecurityZoneHeaderInfo (JSON)

Example

Request

GET /zones/zones/zone-headers/for-service/{serviceId}
Content-Type: */*
Accept: application/json

                
...

Response

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

                
[ {
  "name" : "...",
  "createdBy" : "...",
  "createTime" : 12345,
  "id" : 12345,
  "version" : 12345,
  "isEnabled" : true,
  "guid" : "...",
  "updateTime" : 12345,
  "updatedBy" : "..."
} ]

SecurityZoneREST Resource

GET /zones/summary

Example

Request

Response

GET /zones/zones

Example

Request

Response

POST /zones/zones

Example

Request

Response

DELETE /zones/zones/{id}

Example

Request

Response

GET /zones/zones/{id}

Example

Request

Response

PUT /zones/zones/{id}

Example

Request

Response

GET /zones/zone-names/{serviceName}/resource

Example

Request

Response

DELETE /zones/zones/name/{name}

Example

Request

Response

GET /zones/zones/name/{name}

Example

Request

Response

GET /zones/zones/zone-headers/for-service/{serviceId}

Example

Request

Response