Jump to

• Request
• Response
• Examples

Revoke Current User

delete

/documents/api/1.2/shares/{folderId}/myuser

Delete the current user's access to a shared folder.

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.

Back to Top

Response

Supported Media Types

• application/json
• application/xml

200 Response

The request was fulfilled.

Body ()

Root Schema : ShareDeleteUserResponse

Type: object

The response body includes information about the revoke user operation.

Show Source

• errorCode(optional): string
  An error code of zero (0) indicates no errors.
• id(optional): string
  Globally unique identifier (GUID) for the folder.
• members(optional): array members
  Users or groups whose roles are revoked in the current request.
• type(optional): string
  Item type share.

{
    "description":"The response body includes information about the revoke user operation.",
    "properties":{
        "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."
        },
        "members":{
            "type":"array",
            "description":"Users or groups whose roles are revoked in the current request.",
            "items":{
                "type":"object",
                "properties":{
                    "id":{
                        "type":"string",
                        "description":"User or group identifier as supplied in the request body&#39;s <code>userID</code> parameter."
                    },
                    "displayName":{
                        "type":"string",
                        "description":"User or group diplay name."
                    },
                    "type":{
                        "type":"string",
                        "description":"Member type, has value <code>user</code> or <code>group</code>."
                    },
                    "isSuccessful":{
                        "type":"string",
                        "description":"Whether deleting this member was successful. (1) indicates success, (0) indicates failure."
                    },
                    "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><p>Not returned if the type is <code>group</code>.</p>"
                    }
                }
            }
        }
    }
}

Nested Schema : members

Type: array

Users or groups whose roles are revoked in the current request.

Show Source

• Array of: object items

{
    "type":"array",
    "description":"Users or groups whose roles are revoked in the current request.",
    "items":{
        "type":"object",
        "properties":{
            "id":{
                "type":"string",
                "description":"User or group identifier as supplied in the request body&#39;s <code>userID</code> parameter."
            },
            "displayName":{
                "type":"string",
                "description":"User or group diplay name."
            },
            "type":{
                "type":"string",
                "description":"Member type, has value <code>user</code> or <code>group</code>."
            },
            "isSuccessful":{
                "type":"string",
                "description":"Whether deleting this member was successful. (1) indicates success, (0) indicates failure."
            },
            "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><p>Not returned if the type is <code>group</code>.</p>"
            }
        }
    }
}

Nested Schema : items

Type: object

Show Source

• displayName(optional): string
  User or group diplay name.
• id(optional): string
  User or group identifier as supplied in the request body's userID parameter.
• isSuccessful(optional): string
  Whether deleting this member was successful. (1) indicates success, (0) indicates failure.
• 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.

  Not returned if the type is group.

• type(optional): string
  Member type, has value user or group.

{
    "type":"object",
    "properties":{
        "id":{
            "type":"string",
            "description":"User or group identifier as supplied in the request body&#39;s <code>userID</code> parameter."
        },
        "displayName":{
            "type":"string",
            "description":"User or group diplay name."
        },
        "type":{
            "type":"string",
            "description":"Member type, has value <code>user</code> or <code>group</code>."
        },
        "isSuccessful":{
            "type":"string",
            "description":"Whether deleting this member was successful. (1) indicates success, (0) indicates failure."
        },
        "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><p>Not returned if the type is <code>group</code>.</p>"
        }
    }
}

Example Response (application/json)

{
    "id":"F1321DC48E3B123D02DBEE88T0000000000100000001",
    "type":"share",
    "errorCode":"0"
}

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 removes access to the specified folder for the current user.

DELETE .../shares/F1321DC48E3B123D02DBEE88T0000000000100000001/myuser

Request Header

None.

Request Body

None.

HTTP Status Code

HTTP_STATUS = 200

JSON Response

{
    "errorCode": "0",
    "id": "F10CD743291B0B4B86366730T0000000000100000001",
    "type": "share"
}

Back to Top