Ranger REST API: RoleREST

GET /roles/roles

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

Example

Request

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

                
...

Response

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

                
{
  "roles" : [ {
    "groups" : [ {
      "name" : "...",
      "isAdmin" : true
    }, {
      "name" : "...",
      "isAdmin" : true
    } ],
    "users" : [ {
      "name" : "...",
      "isAdmin" : true
    }, {
      "name" : "...",
      "isAdmin" : true
    } ],
    "options" : {
      "property1" : { },
      "property2" : { }
    },
    "createdByUser" : "...",
    "roles" : [ {
      "name" : "...",
      "isAdmin" : true
    }, {
      "name" : "...",
      "isAdmin" : true
    } ],
    "description" : "...",
    "name" : "...",
    "guid" : "...",
    "isEnabled" : true,
    "createTime" : 12345,
    "createdBy" : "...",
    "updatedBy" : "...",
    "id" : 12345,
    "updateTime" : 12345,
    "version" : 12345
  }, {
    "groups" : [ {
      "name" : "...",
      "isAdmin" : true
    }, {
      "name" : "...",
      "isAdmin" : true
    } ],
    "users" : [ {
      "name" : "...",
      "isAdmin" : true
    }, {
      "name" : "...",
      "isAdmin" : true
    } ],
    "options" : {
      "property1" : { },
      "property2" : { }
    },
    "createdByUser" : "...",
    "roles" : [ {
      "name" : "...",
      "isAdmin" : true
    }, {
      "name" : "...",
      "isAdmin" : true
    } ],
    "description" : "...",
    "name" : "...",
    "guid" : "...",
    "isEnabled" : true,
    "createTime" : 12345,
    "createdBy" : "...",
    "updatedBy" : "...",
    "id" : 12345,
    "updateTime" : 12345,
    "version" : 12345
  } ],
  "listSize" : 12345,
  "list" : [ { }, { } ],
  "startIndex" : 12345,
  "pageSize" : 12345,
  "totalCount" : 12345,
  "resultSize" : 12345,
  "sortType" : "...",
  "sortBy" : "..."
}

POST /roles/roles

Request Parameters
name	type	description	default	constraints
createNonExistUserGroup	query		false	boolean
serviceName	query

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

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

Example

Request

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

                
{
  "groups" : [ {
    "name" : "...",
    "isAdmin" : true
  }, {
    "name" : "...",
    "isAdmin" : true
  } ],
  "users" : [ {
    "name" : "...",
    "isAdmin" : true
  }, {
    "name" : "...",
    "isAdmin" : true
  } ],
  "options" : {
    "property1" : { },
    "property2" : { }
  },
  "createdByUser" : "...",
  "roles" : [ {
    "name" : "...",
    "isAdmin" : true
  }, {
    "name" : "...",
    "isAdmin" : true
  } ],
  "description" : "...",
  "name" : "...",
  "guid" : "...",
  "isEnabled" : true,
  "createTime" : 12345,
  "createdBy" : "...",
  "updatedBy" : "...",
  "id" : 12345,
  "updateTime" : 12345,
  "version" : 12345
}

Response

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

                
{
  "groups" : [ {
    "name" : "...",
    "isAdmin" : true
  }, {
    "name" : "...",
    "isAdmin" : true
  } ],
  "users" : [ {
    "name" : "...",
    "isAdmin" : true
  }, {
    "name" : "...",
    "isAdmin" : true
  } ],
  "options" : {
    "property1" : { },
    "property2" : { }
  },
  "createdByUser" : "...",
  "roles" : [ {
    "name" : "...",
    "isAdmin" : true
  }, {
    "name" : "...",
    "isAdmin" : true
  } ],
  "description" : "...",
  "name" : "...",
  "guid" : "...",
  "isEnabled" : true,
  "createTime" : 12345,
  "createdBy" : "...",
  "updatedBy" : "...",
  "id" : 12345,
  "updateTime" : 12345,
  "version" : 12345
}

GET /roles/download/{serviceName}

Request Parameters
name	type	default	constraints
serviceName	path
clusterName	query
lastActivationTime	query	0	long
lastKnownRoleVersion	query	-1	long
pluginCapabilities	query
pluginId	query

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

Example

Request

GET /roles/download/{serviceName}
Content-Type: */*
Accept: application/json

                
...

Response

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

                
{
  "roleVersion" : 12345,
  "rangerRoles" : [ {
    "groups" : [ {
      "name" : "...",
      "isAdmin" : true
    }, {
      "name" : "...",
      "isAdmin" : true
    } ],
    "users" : [ {
      "name" : "...",
      "isAdmin" : true
    }, {
      "name" : "...",
      "isAdmin" : true
    } ],
    "options" : {
      "property1" : { },
      "property2" : { }
    },
    "createdByUser" : "...",
    "roles" : [ {
      "name" : "...",
      "isAdmin" : true
    }, {
      "name" : "...",
      "isAdmin" : true
    } ],
    "description" : "...",
    "name" : "...",
    "guid" : "...",
    "isEnabled" : true,
    "createTime" : 12345,
    "createdBy" : "...",
    "updatedBy" : "...",
    "id" : 12345,
    "updateTime" : 12345,
    "version" : 12345
  }, {
    "groups" : [ {
      "name" : "...",
      "isAdmin" : true
    }, {
      "name" : "...",
      "isAdmin" : true
    } ],
    "users" : [ {
      "name" : "...",
      "isAdmin" : true
    }, {
      "name" : "...",
      "isAdmin" : true
    } ],
    "options" : {
      "property1" : { },
      "property2" : { }
    },
    "createdByUser" : "...",
    "roles" : [ {
      "name" : "...",
      "isAdmin" : true
    }, {
      "name" : "...",
      "isAdmin" : true
    } ],
    "description" : "...",
    "name" : "...",
    "guid" : "...",
    "isEnabled" : true,
    "createTime" : 12345,
    "createdBy" : "...",
    "updatedBy" : "...",
    "id" : 12345,
    "updateTime" : 12345,
    "version" : 12345
  } ],
  "roleUpdateTime" : 12345,
  "serviceName" : "..."
}

GET /roles/lookup/roles

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

Example

Request

GET /roles/lookup/roles
Content-Type: */*
Accept: application/json

                
...

Response

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

                
{
  "roles" : [ {
    "groups" : [ {
      "name" : "...",
      "isAdmin" : true
    }, {
      "name" : "...",
      "isAdmin" : true
    } ],
    "users" : [ {
      "name" : "...",
      "isAdmin" : true
    }, {
      "name" : "...",
      "isAdmin" : true
    } ],
    "options" : {
      "property1" : { },
      "property2" : { }
    },
    "createdByUser" : "...",
    "roles" : [ {
      "name" : "...",
      "isAdmin" : true
    }, {
      "name" : "...",
      "isAdmin" : true
    } ],
    "description" : "...",
    "name" : "...",
    "guid" : "...",
    "isEnabled" : true,
    "createTime" : 12345,
    "createdBy" : "...",
    "updatedBy" : "...",
    "id" : 12345,
    "updateTime" : 12345,
    "version" : 12345
  }, {
    "groups" : [ {
      "name" : "...",
      "isAdmin" : true
    }, {
      "name" : "...",
      "isAdmin" : true
    } ],
    "users" : [ {
      "name" : "...",
      "isAdmin" : true
    }, {
      "name" : "...",
      "isAdmin" : true
    } ],
    "options" : {
      "property1" : { },
      "property2" : { }
    },
    "createdByUser" : "...",
    "roles" : [ {
      "name" : "...",
      "isAdmin" : true
    }, {
      "name" : "...",
      "isAdmin" : true
    } ],
    "description" : "...",
    "name" : "...",
    "guid" : "...",
    "isEnabled" : true,
    "createTime" : 12345,
    "createdBy" : "...",
    "updatedBy" : "...",
    "id" : 12345,
    "updateTime" : 12345,
    "version" : 12345
  } ],
  "listSize" : 12345,
  "list" : [ { }, { } ],
  "startIndex" : 12345,
  "pageSize" : 12345,
  "totalCount" : 12345,
  "resultSize" : 12345,
  "sortType" : "...",
  "sortBy" : "..."
}

GET /roles/roles/names

Request Parameters
name	type	description
execUser	query
serviceName	query

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

Example

Request

GET /roles/roles/names
Content-Type: */*
Accept: application/json

                
...

Response

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

                
...

DELETE /roles/roles/{id}

Request Parameters
name	type	description	constraints
id	path		long

Example

Request

DELETE /roles/roles/{id}
Content-Type: */*

                
...

Response

HTTP/1.1 204 No Content

GET /roles/roles/{id}

Request Parameters
name	type	description	constraints
id	path		long

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

Example

Request

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

                
...

Response

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

                
{
  "groups" : [ {
    "name" : "...",
    "isAdmin" : true
  }, {
    "name" : "...",
    "isAdmin" : true
  } ],
  "users" : [ {
    "name" : "...",
    "isAdmin" : true
  }, {
    "name" : "...",
    "isAdmin" : true
  } ],
  "options" : {
    "property1" : { },
    "property2" : { }
  },
  "createdByUser" : "...",
  "roles" : [ {
    "name" : "...",
    "isAdmin" : true
  }, {
    "name" : "...",
    "isAdmin" : true
  } ],
  "description" : "...",
  "name" : "...",
  "guid" : "...",
  "isEnabled" : true,
  "createTime" : 12345,
  "createdBy" : "...",
  "updatedBy" : "...",
  "id" : 12345,
  "updateTime" : 12345,
  "version" : 12345
}

PUT /roles/roles/{id}

Request Parameters
name	type	description	default	constraints
id	path			long
createNonExistUserGroup	query		false	boolean

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

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

Example

Request

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

                
{
  "groups" : [ {
    "name" : "...",
    "isAdmin" : true
  }, {
    "name" : "...",
    "isAdmin" : true
  } ],
  "users" : [ {
    "name" : "...",
    "isAdmin" : true
  }, {
    "name" : "...",
    "isAdmin" : true
  } ],
  "options" : {
    "property1" : { },
    "property2" : { }
  },
  "createdByUser" : "...",
  "roles" : [ {
    "name" : "...",
    "isAdmin" : true
  }, {
    "name" : "...",
    "isAdmin" : true
  } ],
  "description" : "...",
  "name" : "...",
  "guid" : "...",
  "isEnabled" : true,
  "createTime" : 12345,
  "createdBy" : "...",
  "updatedBy" : "...",
  "id" : 12345,
  "updateTime" : 12345,
  "version" : 12345
}

Response

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

                
{
  "groups" : [ {
    "name" : "...",
    "isAdmin" : true
  }, {
    "name" : "...",
    "isAdmin" : true
  } ],
  "users" : [ {
    "name" : "...",
    "isAdmin" : true
  }, {
    "name" : "...",
    "isAdmin" : true
  } ],
  "options" : {
    "property1" : { },
    "property2" : { }
  },
  "createdByUser" : "...",
  "roles" : [ {
    "name" : "...",
    "isAdmin" : true
  }, {
    "name" : "...",
    "isAdmin" : true
  } ],
  "description" : "...",
  "name" : "...",
  "guid" : "...",
  "isEnabled" : true,
  "createTime" : 12345,
  "createdBy" : "...",
  "updatedBy" : "...",
  "id" : 12345,
  "updateTime" : 12345,
  "version" : 12345
}

PUT /roles/roles/grant/{serviceName}

Request Parameters
name	type	description
serviceName	path

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

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

Example

Request

PUT /roles/roles/grant/{serviceName}
Content-Type: application/json
Accept: application/json

                
{
  "grantOption" : true,
  "clientIPAddress" : "...",
  "users" : [ "...", "..." ],
  "grantor" : "...",
  "targetRoles" : [ "...", "..." ],
  "requestData" : "...",
  "sessionId" : "...",
  "grantorGroups" : [ "...", "..." ],
  "clusterName" : "...",
  "roles" : [ "...", "..." ],
  "clientType" : "...",
  "groups" : [ "...", "..." ]
}

Response

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

                
{
  "message" : "...",
  "httpStatusCode" : 12345,
  "msgDesc" : "...",
  "statusCode" : 12345,
  "messageList" : [ {
    "objectId" : 12345,
    "fieldName" : "...",
    "message" : "...",
    "name" : "...",
    "rbKey" : "..."
  }, {
    "objectId" : 12345,
    "fieldName" : "...",
    "message" : "...",
    "name" : "...",
    "rbKey" : "..."
  } ]
}

DELETE /roles/roles/name/{name}

Request Parameters
name	type	description
name	path
execUser	query
serviceName	query

Example

Request

DELETE /roles/roles/name/{name}
Content-Type: */*

                
...

Response

HTTP/1.1 204 No Content

GET /roles/roles/name/{name}

Request Parameters
name	type	description
name	path
execUser	query
serviceName	query

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

Example

Request

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

                
...

Response

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

                
{
  "groups" : [ {
    "name" : "...",
    "isAdmin" : true
  }, {
    "name" : "...",
    "isAdmin" : true
  } ],
  "users" : [ {
    "name" : "...",
    "isAdmin" : true
  }, {
    "name" : "...",
    "isAdmin" : true
  } ],
  "options" : {
    "property1" : { },
    "property2" : { }
  },
  "createdByUser" : "...",
  "roles" : [ {
    "name" : "...",
    "isAdmin" : true
  }, {
    "name" : "...",
    "isAdmin" : true
  } ],
  "description" : "...",
  "name" : "...",
  "guid" : "...",
  "isEnabled" : true,
  "createTime" : 12345,
  "createdBy" : "...",
  "updatedBy" : "...",
  "id" : 12345,
  "updateTime" : 12345,
  "version" : 12345
}

PUT /roles/roles/revoke/{serviceName}

Request Parameters
name	type	description
serviceName	path

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

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

Example

Request

PUT /roles/roles/revoke/{serviceName}
Content-Type: application/json
Accept: application/json

                
{
  "grantOption" : true,
  "clientIPAddress" : "...",
  "users" : [ "...", "..." ],
  "grantor" : "...",
  "targetRoles" : [ "...", "..." ],
  "requestData" : "...",
  "sessionId" : "...",
  "grantorGroups" : [ "...", "..." ],
  "clusterName" : "...",
  "roles" : [ "...", "..." ],
  "clientType" : "...",
  "groups" : [ "...", "..." ]
}

Response

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

                
{
  "message" : "...",
  "httpStatusCode" : 12345,
  "msgDesc" : "...",
  "statusCode" : 12345,
  "messageList" : [ {
    "objectId" : 12345,
    "fieldName" : "...",
    "message" : "...",
    "name" : "...",
    "rbKey" : "..."
  }, {
    "objectId" : 12345,
    "fieldName" : "...",
    "message" : "...",
    "name" : "...",
    "rbKey" : "..."
  } ]
}

GET /roles/roles/user/{user}

Request Parameters
name	type	description
user	path

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

Example

Request

GET /roles/roles/user/{user}
Content-Type: */*
Accept: application/json

                
...

Response

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

                
...

PUT /roles/roles/{id}/addUsersAndGroups

Request Parameters
name	type	description	constraints
id	path		long

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

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

Example

Request

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

                
...

Response

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

                
{
  "groups" : [ {
    "name" : "...",
    "isAdmin" : true
  }, {
    "name" : "...",
    "isAdmin" : true
  } ],
  "users" : [ {
    "name" : "...",
    "isAdmin" : true
  }, {
    "name" : "...",
    "isAdmin" : true
  } ],
  "options" : {
    "property1" : { },
    "property2" : { }
  },
  "createdByUser" : "...",
  "roles" : [ {
    "name" : "...",
    "isAdmin" : true
  }, {
    "name" : "...",
    "isAdmin" : true
  } ],
  "description" : "...",
  "name" : "...",
  "guid" : "...",
  "isEnabled" : true,
  "createTime" : 12345,
  "createdBy" : "...",
  "updatedBy" : "...",
  "id" : 12345,
  "updateTime" : 12345,
  "version" : 12345
}

PUT /roles/roles/{id}/removeAdminFromUsersAndGroups

Request Parameters
name	type	description	constraints
id	path		long

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

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

Example

Request

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

                
...

Response

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

                
{
  "groups" : [ {
    "name" : "...",
    "isAdmin" : true
  }, {
    "name" : "...",
    "isAdmin" : true
  } ],
  "users" : [ {
    "name" : "...",
    "isAdmin" : true
  }, {
    "name" : "...",
    "isAdmin" : true
  } ],
  "options" : {
    "property1" : { },
    "property2" : { }
  },
  "createdByUser" : "...",
  "roles" : [ {
    "name" : "...",
    "isAdmin" : true
  }, {
    "name" : "...",
    "isAdmin" : true
  } ],
  "description" : "...",
  "name" : "...",
  "guid" : "...",
  "isEnabled" : true,
  "createTime" : 12345,
  "createdBy" : "...",
  "updatedBy" : "...",
  "id" : 12345,
  "updateTime" : 12345,
  "version" : 12345
}

PUT /roles/roles/{id}/removeUsersAndGroups

Request Parameters
name	type	description	constraints
id	path		long

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

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

Example

Request

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

                
...

Response

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

                
{
  "groups" : [ {
    "name" : "...",
    "isAdmin" : true
  }, {
    "name" : "...",
    "isAdmin" : true
  } ],
  "users" : [ {
    "name" : "...",
    "isAdmin" : true
  }, {
    "name" : "...",
    "isAdmin" : true
  } ],
  "options" : {
    "property1" : { },
    "property2" : { }
  },
  "createdByUser" : "...",
  "roles" : [ {
    "name" : "...",
    "isAdmin" : true
  }, {
    "name" : "...",
    "isAdmin" : true
  } ],
  "description" : "...",
  "name" : "...",
  "guid" : "...",
  "isEnabled" : true,
  "createTime" : 12345,
  "createdBy" : "...",
  "updatedBy" : "...",
  "id" : 12345,
  "updateTime" : 12345,
  "version" : 12345
}

GET /roles/secure/download/{serviceName}

Request Parameters
name	type	default	constraints
serviceName	path
clusterName	query
lastActivationTime	query	0	long
lastKnownRoleVersion	query	-1	long
pluginCapabilities	query
pluginId	query

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

Example

Request

GET /roles/secure/download/{serviceName}
Content-Type: */*
Accept: application/json

                
...

Response

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

                
{
  "roleVersion" : 12345,
  "rangerRoles" : [ {
    "groups" : [ {
      "name" : "...",
      "isAdmin" : true
    }, {
      "name" : "...",
      "isAdmin" : true
    } ],
    "users" : [ {
      "name" : "...",
      "isAdmin" : true
    }, {
      "name" : "...",
      "isAdmin" : true
    } ],
    "options" : {
      "property1" : { },
      "property2" : { }
    },
    "createdByUser" : "...",
    "roles" : [ {
      "name" : "...",
      "isAdmin" : true
    }, {
      "name" : "...",
      "isAdmin" : true
    } ],
    "description" : "...",
    "name" : "...",
    "guid" : "...",
    "isEnabled" : true,
    "createTime" : 12345,
    "createdBy" : "...",
    "updatedBy" : "...",
    "id" : 12345,
    "updateTime" : 12345,
    "version" : 12345
  }, {
    "groups" : [ {
      "name" : "...",
      "isAdmin" : true
    }, {
      "name" : "...",
      "isAdmin" : true
    } ],
    "users" : [ {
      "name" : "...",
      "isAdmin" : true
    }, {
      "name" : "...",
      "isAdmin" : true
    } ],
    "options" : {
      "property1" : { },
      "property2" : { }
    },
    "createdByUser" : "...",
    "roles" : [ {
      "name" : "...",
      "isAdmin" : true
    }, {
      "name" : "...",
      "isAdmin" : true
    } ],
    "description" : "...",
    "name" : "...",
    "guid" : "...",
    "isEnabled" : true,
    "createTime" : 12345,
    "createdBy" : "...",
    "updatedBy" : "...",
    "id" : 12345,
    "updateTime" : 12345,
    "version" : 12345
  } ],
  "roleUpdateTime" : 12345,
  "serviceName" : "..."
}

RoleREST Resource

GET /roles/roles

Example

Request

Response

POST /roles/roles

Example

Request

Response

GET /roles/download/{serviceName}

Example

Request

Response

GET /roles/lookup/roles

Example

Request

Response

GET /roles/roles/names

Example

Request

Response

DELETE /roles/roles/{id}

Example

Request

Response

GET /roles/roles/{id}

Example

Request

Response

PUT /roles/roles/{id}

Example

Request

Response

PUT /roles/roles/grant/{serviceName}

Example

Request

Response

DELETE /roles/roles/name/{name}

Example

Request

Response

GET /roles/roles/name/{name}

Example

Request

Response

PUT /roles/roles/revoke/{serviceName}

Example

Request

Response

GET /roles/roles/user/{user}

Example

Request

Response

PUT /roles/roles/{id}/addUsersAndGroups

Example

Request

Response

PUT /roles/roles/{id}/removeAdminFromUsersAndGroups

Example

Request

Response

PUT /roles/roles/{id}/removeUsersAndGroups

Example

Request

Response

GET /roles/secure/download/{serviceName}

Example

Request

Response