Get User Access Permissions
get
/rest/v16/companies/{companyName}/users/{userName}/accessPermissions
This endpoint returns Product Family and Data Table folder access permissions for the specified user. Note: Access permissions for a user will be available only when Administrator Groups are disabled.
Request
Path Parameters
-
companyName(required): string
Company login name. For Host Company users, use _host. For Partner Organization users, use partner organization company login name.
-
userName(required): string
Login of the user.
Query Parameters
-
excludeLinks: string
Exclude given link types from response.
-
fields: string
Restrict which fields shall be returned. The value is a comma delimited string and each token is a field name.
Response
Supported Media Types
- application/json
Default Response
User Access Permissions
Root Schema : Access Permissions
Type:
object
Title:
Access Permissions
Access Permissions of a user
Show Source
-
items:
array items
-
links:
array Links to the related objects
Title:
Links to the related objects
Links to the related objects
Nested Schema : items
Type:
Show Source
array
-
Array of:
object Access Permission
Title:
Access Permission
User access bits information
Nested Schema : Links to the related objects
Type:
array
Title:
Links to the related objects
Links to the related objects
Show Source
-
Array of:
object reference links
Title:
reference links
Reference links for the Parent, Self, Children and Related as applicable
Nested Schema : Access Permission
Type:
object
Title:
Access Permission
User access bits information
Show Source
-
hasAccess:
boolean
Title:
Has Access
Boolean attribute that indicates if a user has access to the restricted entity. -
name:
string
Title:
Restricted Entity Name
Name of the entity to which access restrictions apply -
type:
string
Title:
Type
Type of the restricted entity. Possible values productFamily, supportedProductFamily and dataTableFolder -
variableName:
string
Title:
Restricted Entity Variable Name
Variable name of the entity to which access restrictions apply
Nested Schema : reference links
Type:
object
Title:
reference links
Reference links for the Parent, Self, Children and Related as applicable
Show Source
-
href:
string
Title:
URL to the related object
URL to the related object -
name:
string
-
rel:
string
Title:
Link Relationship to the current object
Default Value:self
Link Relationship to the current object
Examples
This endpoint returns Product Family, Supported Product Families, and Data Table folder access permissions for the specified userThis endpoint returns Product Family, Supported Product Families, and Data Table folder access permissions for the specified user by submitting a GET request to the REST resource using cURL. For more information about cURL, see Use cURL.
Note: Access permissions for a user will be available only when Admin Access Control is disabled.
curl - X GET - i - H "Authorization: Basic dXNlcm5hbWU6cGFzc3dvcmQg" https://sitename.oracle.com/rest/v16/companies/_host/users/aavenkatbulk/accessPermissions
Response Body Sample
{ "items": [{ "name": "Testbed", "variableName": "testbed", "hasAccess": true, "type": "productFamily" }, { "name": "Admin", "variableName": "admin", "hasAccess": true, "type": "productFamily" }, { "name": "Test 4", "variableName": "test4", "hasAccess": true, "type": "supportedProductFamily" }, { "name": "[Default]", "variableName": "_default", "hasAccess": true, "type": "dataTableFolder" } ], "links": [{ "rel": "self", "href": "https://sitename.oracle.com/rest/v16/companies/_host/users/aavenkatbulk/accessPermissions" }, { "rel": "parent", "href": "https://sitename.oracle.com/rest/v16/companies/_host/users/aavenkatbulk" } ] }