DELETE /api/groups/{GroupID}/members

Removes the multiple groups or users from a specified group.

Valid in Version: 2022.1.3 and later

Authorization Roles/Permissions: Must be logged in. Must have Modify permission for the resource. For example, a Group Leader, Site Admin, or Business Admin can perform this action.

This topic includes the following sections:

HTTP Method

DELETE

URL

https://{hostname}/api/groups/{GroupID}/members

Sample Request

The example below shows a request to remove the user and a group associated with a role from the specified domain.

Sample Request URL

https://{hostname}/api/groups/tenantbusiness.acmepaymentscorp/members

Sample request headers

Accept: */*
Content-Type: application/json
Connection: Keep-Alive
X-Csrf-Token_acmepaymentscorp: TokenID%3D8ed70a13-8469-11e8-b37a-b155e4eabeb8%2CexpirationTime%3D153...

Sample request body

{
  "MembershipRequests": [
     {
        "Role":"com.soa.group.membership.role.admin",
        "UserName": "all-admin-direct-ldap-user",
        "DomainName": "LDAP"
     }
     {
        "Role": "com.soa.group.membership.role.admin", 
        "DomainName": "LDAP",
        "GroupName": "SiteAdministrators",
        "GroupID": "355c9a7a-3c1f-426f-8da7-8a2fe58bbf57.acmepaymentscorp"
     }
  ]						
}

Request Headers

For general information on request header values, refer to HTTP Request Headers.

Header	Description
Accept	*/*, application/json
Content-Type	application/json, application/vnd.akana.v2023+json
X-Csrf-Token_{fedmemberID}	The CSRF prevention header; may or may not be required, depending on platform settings. See CSRF Prevention on the Platform. By default, the CSRF header is not required for GET operations and is required for all others, with a few exceptions relating to user login.

Request Parameters

Parameter	Parm Type	Data Type	Required	Description
GroupID	Path	string	Required	The unique ID for a specific group.
MembershipRequest	Body	MembershipRequest	Required	Contains information about the user's membership in a group.

Response

If successful, this operation returns HTTP status code 200.

Sample Response

The sample response below shows successful completion of this operation.

Sample response headers

Content-Type: application/json
status: 200 OK
Date Mon, 2 Aug 2023 18:48:28 GMT

Sample response body

{
  "MembershipResponses": [
     {
        "GroupName": "SiteAdministrators",
        "DomainName": "LDAP",
        "ResponseMessage": "Success"
     },
     {
        "UserName": "all-admin-direct-ldap-user", 
        "DomainName": "LDAP",
        "ResponseMessage": "Success",
     }
  ]						
}

Response Headers

For general information on response header values, refer to HTTP Response Headers.

Header	Description
Content-Type	application/vnd.akana.v2023+json

Response Body

Name	Type	Description
Membership[ ]	Membership	Contains information about a user or group membership for a group.

Error Codes/Messages

If the call is unsuccessful an error code/message is returned. One or more examples of possible errors for this operation are shown below.

Item	Value
401	Unauthorized. For example, you would get this response if you didn't include the custom X-Csrf-Token_{fedmemberID} header in the request, when it was required by the platform settings; or if you included an invalid or expired value for this header. You would also get this response for any operation that requires login (almost all) if the login cookie was missing.
404	The resource could not be found.
405	Method Not Allowed. You might get this if there is an error in the URL, or if you used the wrong HTTP verb.
500	An error occurred processing the call.

More information about Akana API Platform API error messages.

Related Topics