Enterprise Data Catalog REST API Reference > Security REST API > Security REST API Overview
  

Security REST API Overview

You can use the Security API to list the access permissions on resources for specific users and groups.

List Access Filters

/security/accessFilters
API to list the access permissions for resources and assets in Enterprise Data Catalog.
REST API Element
Input Format
Request URL
<CatalogAdmin>:<port>/access/2/catalog/security/accessFilters
HTTP Method Type
GET

Request Parameters

Parameter
Required or Optional
Description
Parameter Type
Data Type
memberName
Optional
The name of the user or group to filter the list.
Query
string
includeInherited
Optional
Choose true if you want to retrieve the access filters assigned to groups that the user belongs to.
Query
boolean
memberType
Optional
Specify whether the value that you entered for the memberName parameter is the name of a user or a group. Provide one of the following values:
  • - USER
  • - GROUP
Query
string
offset
Optional
The offset position from which the list of permissions must start. Default is 0.
Query
integer
pageSize
Optional
The number of results to be displayed on a page. Default is 20.
Query
integer
resourceName
Optional
The name of the resource to filter the list.
Query
string

Response Codes

Code
Reason
200
Listed the access filters.
400
Missing or invalid parameter.
401
Missing credentials.
403
User does not have the required access permissions.
404
Requested object not found.
429
Rate limit for requests encountered.

Sample Call Using Curl

curl -X GET "http://<CatalogAdmin>:<port>/access/2/catalog/security/accessFilters?includeInherited=false&memberType=USER&offset=0&pageSize=20&resourceName=Ora" -H "accept: application/json"