admin
Child pages
  • DeleteGroup
Skip to end of metadata
Go to start of metadata

Description

The DeleteGroup API allows the Account Owner to delete a specific Group. Users, who are members of the Group, do not get deleted.

In apstrata, data read and write permissions are controlled using ACLs (from wikipedia: Access Control Lists). Each read or write ACL contains a list of Users and/or Groups specifying who can read or write the data for which the ACL is defined.

Users with the same privileges are set as members of the same Group. A user can belong to one or more Groups or no Group at all. Once a Group is created, it can be used in ACLs to define access permissions for more than one user at the same time. 

For specific details on the creation of a Group, please check the SaveGroup API.

For specific details on adding Users to a Group, please check the SaveUser API.

 

Specific Request Parameters

(Refer to Common Request Parameters)

Name

Description

Required

Default

Possible Values

groupName

The group name to delete.

Yes

 

 

Specific Response Elements

(Refer to Common Response Elements)

Specific Logical Errors

(Refer to Common Logical Error Codes)

Error

Message

Status Code

PARAMETER_REQUIRED

 

400

INVALID_GROUP

The specified group does not exist.

400

Examples

Sample Request

Request URL: http://sandbox.apstrata.com/apsdb/rest/[authenticationkey]/DeleteGroup?apsws.time=[timestamp]&apsws.authSig=[signature]


POST parameters:

groupName=groupA


Sample Response

Success XML:

<response xmlns="http://www.apstrata.com/services/schemas/apstrata_database_response.xsd">
    <metadata>
        <requestId>xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx</requestId>
        <status>success</status>        
    </metadata>
</response>


Failure XML:

<response xmlns="http://www.apstrata.com/services/schemas/apstrata_database_response.xsd">
    <metadata>
        <requestId>xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx</requestId>
        <status>failure</status>
        <errorCode>[errorCode]</errorCode>
        <errorDetail>[failMsg]</errorDetail>
    </metadata>
</response>


Sample JSON Response

{"response": {
    "metadata": {
        "requestId": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
        "status": "success"
    }
}}

 

 

  • No labels