Get Shared Folder Users
get
/documents/api/1.2/shares/{folderId}/items
Get information about a shared folder and the users who share it.
Request
Supported Media Types
- application/json
- application/xml
Path Parameters
-
folderId: string
Globally unique identifier (GUID) for the folder. If the referenced folder is the user's home folder, the value for
.folderId
isself
The request body defines details of the get shared folder users request. There are no required attributes.
Example Request (application/json)
{
"currentOnly":"true"
}
Response
Supported Media Types
- application/json
- application/xml
200 Response
The request was fulfilled.
Nested Schema : UserWithLoginName
Type:
object
User information.
Show Source
-
displayName(optional):
string
The display name for the user.
-
id(optional):
string
Globally unique identifier (GUID) for the user.
-
loginName(optional):
string
The login name for the user.
-
provisioningStatus(optional):
string
Provisioning status for the user:
- active: An active user that has been assigned an Oracle Content Management application role
- inactive: A user that currently has no Content Management application roles assigned.
- deleted: A user that no longer exists in the IAM/IDCS identity domain.
- pending: An external user that was invited but does not exist in the IAM/IDCS identity domain yet.
-
type(optional):
string
Item type
user
.
Example Response (application/json)
{
"count":"1",
"id":"F1321DC48E3B123D02DBEE88T0000000000100000001",
"type":"share",
"errorCode":"0",
"items":[
{
"type":"share",
"role":"manager",
"user":{
"id":"U7ECC74059E0FEDFEC66BF5AT00000000001",
"displayName":"User BB",
"loginName":"userBBLoginName",
"provisioningStatus":"active",
"type":"user"
}
}
],
"ownedBy":{
"id":"U7ECC74059E0FEDFEC66BF5AT00000000002",
"displayName":"User AA",
"loginName":"userAALoginName",
"type":"user"
}
}
400 Response
Request parameters are not formatted correctly.
403 Response
Forbidden if the user does not have read permission.
404 Response
Folder ID is not found.
Examples
The following example retrieves users and groups with access to the specified folder:
GET .../shares/F1321DC48E3B123D02DBEE88T0000000000100000001/items?currentOnly=true
Request Header
None.
Request Body
None.
HTTP Status Code
HTTP_STATUS = 200
JSON Response
{ "count": "1", "errorCode": "0", "id": "F1321DC48E3B123D02DBEE88T0000000000100000001", "type": "share", "items": [ { "type": "share", "user": { "displayName": "User BB", "loginName": "userBBLoginName", "id": "U7ECC74059E0FEDFEC66BF5AT00000000001", "type": "user", "provisioningStatus": "active" }, "role": "manager" } ], "ownedBy": { "id": "U7ECC74059E0FEDFEC66BF5AT00000000002", "displayName": "User AA", "loginName": "userAALoginName", "type": "user" } }