Jump to

• Request
• Response
• Examples

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 is self

  .

Body ()

The request body defines details of the get shared folder users request. There are no required attributes.

Root Schema : ShareFolderUsersBody

Type: object

The request body defines details of the get shared folder users request. There are no required attributes.

Show Source

• currentOnly(optional): string
  Return only users with whom the specified folder is shared explicitly (true) or all users who have access to the specified folder whether directly or via sharing of one of the parent folders (false). By default, this option is false.

{
    "description":"The request body defines details of the get shared folder users request. There are no required attributes.",
    "properties":{
        "currentOnly":{
            "type":"string",
            "description":"Return only users with whom the specified folder is shared explicitly (<code>true</code>) or all users who have access to the specified folder whether directly or via sharing of one of the parent folders (<code>false</code>). By default, this option is <code>false</code>."
        }
    }
}

Example Request (application/json)

{
    "currentOnly":"true"
}

Back to Top

Response

Supported Media Types

• application/json
• application/xml

200 Response

The request was fulfilled.

Body ()

Root Schema : ShareFolderUsersResponse

Type: object

The response body includes information about the get shared folder users operation.

Show Source

• count(optional): string
  The number of items listed on the page.
• errorCode(optional): string
  An error code of zero (0) indicates no errors.
• id(optional): string
  Globally unique identifier (GUID) for the folder.
• items(optional): array items
• ownedBy(optional): object UserWithLoginName
  User information.
• type(optional): string
  Item type share.

{
    "description":"The response body includes information about the get shared folder users operation.",
    "properties":{
        "count":{
            "type":"string",
            "description":"The number of items listed on the page."
        },
        "id":{
            "type":"string",
            "description":"Globally unique identifier (GUID) for the folder."
        },
        "type":{
            "type":"string",
            "description":"Item type <code>share</code>."
        },
        "errorCode":{
            "type":"string",
            "description":"An error code of zero (0) indicates no errors."
        },
        "items":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/ShareDefinition"
            }
        },
        "ownedBy":{
            "$ref":"#/definitions/UserWithLoginName"
        }
    }
}

Nested Schema : items

Type: array

Show Source

• Array of: object ShareDefinition
  Share information

{
    "type":"array",
    "items":{
        "$ref":"#/definitions/ShareDefinition"
    }
}

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.

{
    "description":"User information.",
    "properties":{
        "id":{
            "type":"string",
            "description":"Globally unique identifier (GUID) for the user."
        },
        "displayName":{
            "type":"string",
            "description":"The display name for the user."
        },
        "loginName":{
            "type":"string",
            "description":"The login name for the user."
        },
        "provisioningStatus":{
            "type":"string",
            "description":"<p>Provisioning status for the user:</p><p><ul><li><b>active:</b> An active user that has been assigned an Oracle Content Management application role</li><li><b>inactive:</b> A user that currently has no Content Management application roles assigned.</li><li><b>deleted:</b> A user that no longer exists in the IAM/IDCS identity domain.</li><li><b>pending:</b> An external user that was invited but does not exist in the IAM/IDCS identity domain yet.</li></ul></p>"
        },
        "type":{
            "type":"string",
            "description":"Item type <code>user</code>."
        }
    }
}

Nested Schema : ShareDefinition

Type: object

Share information

Show Source

• role(optional): string
  Allowed Values: [ "viewer", "downloader", "contributor" ]

  Access level for the shared item.
• type(optional): string
  Item type share.
• user(optional): object UserWithLoginName
  User information.

{
    "description":"Share information",
    "properties":{
        "type":{
            "type":"string",
            "description":"Item type <code>share</code>."
        },
        "role":{
            "type":"string",
            "description":"Access level for the shared item.",
            "enum":[
                "viewer",
                "downloader",
                "contributor"
            ]
        },
        "user":{
            "$ref":"#/definitions/UserWithLoginName"
        }
    }
}

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.

Back to Top

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"
  }
}

Back to Top