Remove group members

DELETE 
{baseUrl}/api/2.0/group/:id/members

Removes the group members specified in the request from the selected group.

Request

Path Parameters

id uuidrequired

Group ID

application/json

Body

Members

membersuuid[]nullable
List of group member IDs
Example: ["75a5f745-f697-4418-b38d-0fe0d277e258"]

Responses

200

Group with the detailed information

application/json

Schema

Schema

namestringnullable
Name
Example: Winfield Upton
parentuuidnullable
Parent
Example: 75a5f745-f697-4418-b38d-0fe0d277e258
categoryuuid
Category
Example: 75a5f745-f697-4418-b38d-0fe0d277e258
iduuid
ID
Example: aae1e103-bca5-9fa1-ba8c-42058b4abf28
isLDAPboolean
Specifies if the LDAP settings are enabled for the group or not
Example: true
manager object
iduuid
ID
Example: {00000000-0000-0000-0000-000000000000}
displayNamestringnullable
Display name
Example: Mike Zanyatski
titlestringnullable
Title
Example: Manager
avatarstringnullable
Avatar
Example: some text
avatarOriginalstringnullable
Original size avatar
Example: some text
avatarMaxstringnullable
Maximum size avatar
Example: some text
avatarMediumstringnullable
Medium size avatar
Example: some text
avatarSmallstringnullable
Small avatar
Example: url to small avatar
profileUrlstringnullable
Profile URL
Example: some text
hasAvatarboolean
Specifies if the user has an avatar or not
Example: true
isAnonimboolean
Specifies if the user is an anonim or not
Example: true
firstNamestringnullable
First name
Example: Mike
lastNamestringnullable
Last name
Example: Zanyatski
userNamestringnullable
Username
Example: Mike.Zanyatski
emailemailnullable
Email
Example: my@gmail.com
contacts object[]nullable
List of contacts
Array [
typestringnullable
Contact type
Example: GTalk
valuestringnullable
Contact value
Example: my@gmail.com
]
birthday object
utcTimedate-time
UtcTime
Example: 2008-04-10T06:30:00.0000000+04:00
timeZoneOffsetdate-span
TimeZoneOffset
Example: 00:00:00
sexstringnullable
Sex
Example: male
status object
oneOf
MOD1
string
[Active - Active, Terminated - Terminated, Pending - Pending, Default - Default, All - All]
Possible values: [Active, Terminated, Pending, Default, All]
Example: Active
MOD2
integer
[1 - Active, 2 - Terminated, 4 - Pending, 5 - Default, 7 - All]
Possible values: [1, 2, 4, 5, 7]
Example: 1
activationStatus object
oneOf
MOD1
string
[NotActivated - Not activated, Activated - Activated, Pending - Pending, AutoGenerated - Auto generated]
Possible values: [NotActivated, Activated, Pending, AutoGenerated]
Example: NotActivated
MOD2
integer
[0 - Not activated, 1 - Activated, 2 - Pending, 4 - Auto generated]
Possible values: [0, 1, 2, 4]
Example: 0
terminated object
utcTimedate-time
UtcTime
Example: 2008-04-10T06:30:00.0000000+04:00
timeZoneOffsetdate-span
TimeZoneOffset
Example: 00:00:00
departmentstringnullable
Department
Example: Marketing
workFrom object
utcTimedate-time
UtcTime
Example: 2008-04-10T06:30:00.0000000+04:00
timeZoneOffsetdate-span
TimeZoneOffset
Example: 00:00:00
groups object[]nullable
List of groups
Array [
iduuid
ID
Example: {00000000-0000-0000-0000-000000000000}
namestringnullable
Name
Example: Group Name
managerstringnullable
Manager
Example: Jake.Zazhitski
]
locationstringnullable
Location
Example: Palo Alto
notesstringnullable
Notes
Example: Notes to worker
isAdminboolean
Specifies if the user is an administrator or not
Example: false
isRoomAdminboolean
Specifies if the user is a room administrator or not
Example: true
isLDAPboolean
Specifies if the LDAP settings are enabled for the user or not
Example: false
listAdminModulesstring[]nullable
List of administrator modules
Example: ["projects", "crm"]
isOwnerboolean
Specifies if the user is a portal owner or not
Example: true
isVisitorboolean
Specifies if the user is a portal visitor or not
Example: true
isCollaboratorboolean
Specifies if the user is a portal collaborator or not
Example: true
cultureNamestringnullable
Language
Example: en-EN
mobilePhonestringnullable
Mobile phone number
Example: some text
mobilePhoneActivationStatus object
oneOf
MOD1
string
[NotActivated - Not activated, Activated - Activated]
Possible values: [NotActivated, Activated]
Example: NotActivated
MOD2
integer
[0 - Not activated, 1 - Activated]
Possible values: [0, 1]
Example: 0
isSSOboolean
Specifies if the SSO settings are enabled for the user or not
Example: false
theme object
oneOf
MOD1
string
[Base - Base, Dark - Dark, System - System]
Possible values: [Base, Dark, System]
Example: Base
MOD2
integer
[0 - Base, 1 - Dark, 2 - System]
Possible values: [0, 1, 2]
Example: 0
quotaLimitint64nullable
Quota limit
Example: 1234
usedSpacedoublenullable
Portal used space
Example: 12345
sharedbooleannullable
Shared
Example: true
isCustomQuotabooleannullable
Specifies if the user has a custom quota or not
Example: true
loginEventIdint32nullable
Current login event ID
Example: 1234
createdBy object
iduuid
ID
Example: {00000000-0000-0000-0000-000000000000}
displayNamestringnullable
Display name
Example: Mike Zanyatski
titlestringnullable
Title
Example: Manager
avatarstringnullable
Avatar
Example: some text
avatarOriginalstringnullable
Original size avatar
Example: some text
avatarMaxstringnullable
Maximum size avatar
Example: some text
avatarMediumstringnullable
Medium size avatar
Example: some text
avatarSmallstringnullable
Small avatar
Example: url to small avatar
profileUrlstringnullable
Profile URL
Example: some text
hasAvatarboolean
Specifies if the user has an avatar or not
Example: true
isAnonimboolean
Specifies if the user is an anonim or not
Example: true
registrationDate object
utcTimedate-time
UtcTime
Example: 2008-04-10T06:30:00.0000000+04:00
timeZoneOffsetdate-span
TimeZoneOffset
Example: 00:00:00
members object[]nullable
List of members
Array [
iduuid
ID
Example: {00000000-0000-0000-0000-000000000000}
displayNamestringnullable
Display name
Example: Mike Zanyatski
titlestringnullable
Title
Example: Manager
avatarstringnullable
Avatar
Example: some text
avatarOriginalstringnullable
Original size avatar
Example: some text
avatarMaxstringnullable
Maximum size avatar
Example: some text
avatarMediumstringnullable
Medium size avatar
Example: some text
avatarSmallstringnullable
Small avatar
Example: url to small avatar
profileUrlstringnullable
Profile URL
Example: some text
hasAvatarboolean
Specifies if the user has an avatar or not
Example: true
isAnonimboolean
Specifies if the user is an anonim or not
Example: true
firstNamestringnullable
First name
Example: Mike
lastNamestringnullable
Last name
Example: Zanyatski
userNamestringnullable
Username
Example: Mike.Zanyatski
emailemailnullable
Email
Example: my@gmail.com
contacts object[]nullable
List of contacts
Array [
typestringnullable
Contact type
Example: GTalk
valuestringnullable
Contact value
Example: my@gmail.com
]
birthday object
utcTimedate-time
UtcTime
Example: 2008-04-10T06:30:00.0000000+04:00
timeZoneOffsetdate-span
TimeZoneOffset
Example: 00:00:00
sexstringnullable
Sex
Example: male
status object
oneOf
MOD1
string
[Active - Active, Terminated - Terminated, Pending - Pending, Default - Default, All - All]
Possible values: [Active, Terminated, Pending, Default, All]
Example: Active
MOD2
integer
[1 - Active, 2 - Terminated, 4 - Pending, 5 - Default, 7 - All]
Possible values: [1, 2, 4, 5, 7]
Example: 1
activationStatus object
oneOf
MOD1
string
[NotActivated - Not activated, Activated - Activated, Pending - Pending, AutoGenerated - Auto generated]
Possible values: [NotActivated, Activated, Pending, AutoGenerated]
Example: NotActivated
MOD2
integer
[0 - Not activated, 1 - Activated, 2 - Pending, 4 - Auto generated]
Possible values: [0, 1, 2, 4]
Example: 0
terminated object
utcTimedate-time
UtcTime
Example: 2008-04-10T06:30:00.0000000+04:00
timeZoneOffsetdate-span
TimeZoneOffset
Example: 00:00:00
departmentstringnullable
Department
Example: Marketing
workFrom object
utcTimedate-time
UtcTime
Example: 2008-04-10T06:30:00.0000000+04:00
timeZoneOffsetdate-span
TimeZoneOffset
Example: 00:00:00
groups object[]nullable
List of groups
Array [
iduuid
ID
Example: {00000000-0000-0000-0000-000000000000}
namestringnullable
Name
Example: Group Name
managerstringnullable
Manager
Example: Jake.Zazhitski
]
locationstringnullable
Location
Example: Palo Alto
notesstringnullable
Notes
Example: Notes to worker
isAdminboolean
Specifies if the user is an administrator or not
Example: false
isRoomAdminboolean
Specifies if the user is a room administrator or not
Example: true
isLDAPboolean
Specifies if the LDAP settings are enabled for the user or not
Example: false
listAdminModulesstring[]nullable
List of administrator modules
Example: ["projects", "crm"]
isOwnerboolean
Specifies if the user is a portal owner or not
Example: true
isVisitorboolean
Specifies if the user is a portal visitor or not
Example: true
isCollaboratorboolean
Specifies if the user is a portal collaborator or not
Example: true
cultureNamestringnullable
Language
Example: en-EN
mobilePhonestringnullable
Mobile phone number
Example: some text
mobilePhoneActivationStatus object
oneOf
MOD1
string
[NotActivated - Not activated, Activated - Activated]
Possible values: [NotActivated, Activated]
Example: NotActivated
MOD2
integer
[0 - Not activated, 1 - Activated]
Possible values: [0, 1]
Example: 0
isSSOboolean
Specifies if the SSO settings are enabled for the user or not
Example: false
theme object
oneOf
MOD1
string
[Base - Base, Dark - Dark, System - System]
Possible values: [Base, Dark, System]
Example: Base
MOD2
integer
[0 - Base, 1 - Dark, 2 - System]
Possible values: [0, 1, 2]
Example: 0
quotaLimitint64nullable
Quota limit
Example: 1234
usedSpacedoublenullable
Portal used space
Example: 12345
sharedbooleannullable
Shared
Example: true
isCustomQuotabooleannullable
Specifies if the user has a custom quota or not
Example: true
loginEventIdint32nullable
Current login event ID
Example: 1234
createdBy object
iduuid
ID
Example: {00000000-0000-0000-0000-000000000000}
displayNamestringnullable
Display name
Example: Mike Zanyatski
titlestringnullable
Title
Example: Manager
avatarstringnullable
Avatar
Example: some text
avatarOriginalstringnullable
Original size avatar
Example: some text
avatarMaxstringnullable
Maximum size avatar
Example: some text
avatarMediumstringnullable
Medium size avatar
Example: some text
avatarSmallstringnullable
Small avatar
Example: url to small avatar
profileUrlstringnullable
Profile URL
Example: some text
hasAvatarboolean
Specifies if the user has an avatar or not
Example: true
isAnonimboolean
Specifies if the user is an anonim or not
Example: true
registrationDate object
utcTimedate-time
UtcTime
Example: 2008-04-10T06:30:00.0000000+04:00
timeZoneOffsetdate-span
TimeZoneOffset
Example: 00:00:00
]
sharedbooleannullable
Shared
Example: true
membersCountint32
Members count
Example: 1234

Example (auto)

{
  "name": "Winfield Upton",
  "parent": "75a5f745-f697-4418-b38d-0fe0d277e258",
  "category": "75a5f745-f697-4418-b38d-0fe0d277e258",
  "id": "aae1e103-bca5-9fa1-ba8c-42058b4abf28",
  "isLDAP": true,
  "manager": {
    "id": "{00000000-0000-0000-0000-000000000000}",
    "displayName": "Mike Zanyatski",
    "title": "Manager",
    "avatar": "some text",
    "avatarOriginal": "some text",
    "avatarMax": "some text",
    "avatarMedium": "some text",
    "avatarSmall": "url to small avatar",
    "profileUrl": "some text",
    "hasAvatar": true,
    "isAnonim": true,
    "firstName": "Mike",
    "lastName": "Zanyatski",
    "userName": "Mike.Zanyatski",
    "email": "my@gmail.com",
    "contacts": [
      {
        "type": "GTalk",
        "value": "my@gmail.com"
      }
    ],
    "birthday": {
      "utcTime": "2008-04-10T06:30:00.0000000+04:00",
      "timeZoneOffset": "00:00:00"
    },
    "sex": "male",
    "status": "Active",
    "activationStatus": "NotActivated",
    "terminated": {
      "utcTime": "2008-04-10T06:30:00.0000000+04:00",
      "timeZoneOffset": "00:00:00"
    },
    "department": "Marketing",
    "workFrom": {
      "utcTime": "2008-04-10T06:30:00.0000000+04:00",
      "timeZoneOffset": "00:00:00"
    },
    "groups": [
      {
        "id": "{00000000-0000-0000-0000-000000000000}",
        "name": "Group Name",
        "manager": "Jake.Zazhitski"
      }
    ],
    "location": "Palo Alto",
    "notes": "Notes to worker",
    "isAdmin": false,
    "isRoomAdmin": true,
    "isLDAP": false,
    "listAdminModules": "[\"projects\", \"crm\"]",
    "isOwner": true,
    "isVisitor": true,
    "isCollaborator": true,
    "cultureName": "en-EN",
    "mobilePhone": "some text",
    "mobilePhoneActivationStatus": "NotActivated",
    "isSSO": false,
    "theme": "Base",
    "quotaLimit": 1234,
    "usedSpace": 12345,
    "shared": true,
    "isCustomQuota": true,
    "loginEventId": 1234,
    "createdBy": {
      "id": "{00000000-0000-0000-0000-000000000000}",
      "displayName": "Mike Zanyatski",
      "title": "Manager",
      "avatar": "some text",
      "avatarOriginal": "some text",
      "avatarMax": "some text",
      "avatarMedium": "some text",
      "avatarSmall": "url to small avatar",
      "profileUrl": "some text",
      "hasAvatar": true,
      "isAnonim": true
    },
    "registrationDate": {
      "utcTime": "2008-04-10T06:30:00.0000000+04:00",
      "timeZoneOffset": "00:00:00"
    }
  },
  "members": [
    {
      "id": "{00000000-0000-0000-0000-000000000000}",
      "displayName": "Mike Zanyatski",
      "title": "Manager",
      "avatar": "some text",
      "avatarOriginal": "some text",
      "avatarMax": "some text",
      "avatarMedium": "some text",
      "avatarSmall": "url to small avatar",
      "profileUrl": "some text",
      "hasAvatar": true,
      "isAnonim": true,
      "firstName": "Mike",
      "lastName": "Zanyatski",
      "userName": "Mike.Zanyatski",
      "email": "my@gmail.com",
      "contacts": [
        {
          "type": "GTalk",
          "value": "my@gmail.com"
        }
      ],
      "birthday": {
        "utcTime": "2008-04-10T06:30:00.0000000+04:00",
        "timeZoneOffset": "00:00:00"
      },
      "sex": "male",
      "status": "Active",
      "activationStatus": "NotActivated",
      "terminated": {
        "utcTime": "2008-04-10T06:30:00.0000000+04:00",
        "timeZoneOffset": "00:00:00"
      },
      "department": "Marketing",
      "workFrom": {
        "utcTime": "2008-04-10T06:30:00.0000000+04:00",
        "timeZoneOffset": "00:00:00"
      },
      "groups": [
        {
          "id": "{00000000-0000-0000-0000-000000000000}",
          "name": "Group Name",
          "manager": "Jake.Zazhitski"
        }
      ],
      "location": "Palo Alto",
      "notes": "Notes to worker",
      "isAdmin": false,
      "isRoomAdmin": true,
      "isLDAP": false,
      "listAdminModules": "[\"projects\", \"crm\"]",
      "isOwner": true,
      "isVisitor": true,
      "isCollaborator": true,
      "cultureName": "en-EN",
      "mobilePhone": "some text",
      "mobilePhoneActivationStatus": "NotActivated",
      "isSSO": false,
      "theme": "Base",
      "quotaLimit": 1234,
      "usedSpace": 12345,
      "shared": true,
      "isCustomQuota": true,
      "loginEventId": 1234,
      "createdBy": {
        "id": "{00000000-0000-0000-0000-000000000000}",
        "displayName": "Mike Zanyatski",
        "title": "Manager",
        "avatar": "some text",
        "avatarOriginal": "some text",
        "avatarMax": "some text",
        "avatarMedium": "some text",
        "avatarSmall": "url to small avatar",
        "profileUrl": "some text",
        "hasAvatar": true,
        "isAnonim": true
      },
      "registrationDate": {
        "utcTime": "2008-04-10T06:30:00.0000000+04:00",
        "timeZoneOffset": "00:00:00"
      }
    }
  ],
  "shared": true,
  "membersCount": 1234
}

401

Unauthorized

404

Group not found

Authorization: asc_auth_key

name: asc_auth_keytype: apiKeyscopes: read,writein: cookie

• curl
• python
• javascript
• php
• csharp
• java

• CURL

curl -L -X DELETE '/api/2.0/group/:id/members' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-d '{
  "members": [
    "75a5f745-f697-4418-b38d-0fe0d277e258"
  ]
}'

Request Collapse all

Base URL

Auth

asc_auth_key

Parameters

id — pathrequired

Body

{
  "members": [
    "75a5f745-f697-4418-b38d-0fe0d277e258"
  ]
}

ResponseClear

Click the Send API Request button above and see the response here!