Application User Groups Controller Resource

GET /groups

Return list of groups.

Request Parameters
name type description
direction query
filter query
nameLike query
orderBy query
page query
size query
Response Body
media type data type description
application/json array of AppUserGroupListRecord (JSON) list of groups

Example

Request
GET /groups
Content-Type: */*
Accept: application/json

                
...
                
              
Response
HTTP/1.1 200 OK
Content-Type: application/json

                
[ {
  "guid" : "...",
  "name" : "...",
  "description" : "...",
  "deletable" : true,
  "defaultLdapGroup" : true,
  "defaultKeycloakGroup" : true
} ]
                
              

POST /groups

Create a new group.

Request Body
media type data type description
application/json AppUserGroupRequest (JSON) specify data for a new group
Response Body
media type data type description
application/json AppUserGroupDetails (JSON) details of a newly created group

Example

Request
POST /groups
Content-Type: application/json
Accept: application/json

                
{
  "guid" : "...",
  "name" : "...",
  "description" : "...",
  "roles" : [ {
    "guid" : "...",
    "name" : "...",
    "description" : "...",
    "deletable" : true,
    "privileges" : [ "STORAGE_INFRASTRUCTURE_WRITE", "CLOUD_DOWNLOAD_READ" ],
    "privilegeContexts" : [ {
      "type" : "OS_AGENT",
      "instanceGuid" : "...",
      "instanceUuid" : "...",
      "instanceName" : "..."
    }, {
      "type" : "CLOUD_USER",
      "instanceGuid" : "...",
      "instanceUuid" : "...",
      "instanceName" : "..."
    } ],
    "isRootAccess" : true
  }, {
    "guid" : "...",
    "name" : "...",
    "description" : "...",
    "deletable" : true,
    "privileges" : [ "APP_BACKUP_SLA_READ", "NODE_READ" ],
    "privilegeContexts" : [ {
      "type" : "CLOUD_SITE",
      "instanceGuid" : "...",
      "instanceUuid" : "...",
      "instanceName" : "..."
    }, {
      "type" : "STORAGE_POOL",
      "instanceGuid" : "...",
      "instanceUuid" : "...",
      "instanceName" : "..."
    } ],
    "isRootAccess" : true
  } ],
  "users" : [ {
    "guid" : "...",
    "login" : "...",
    "firstName" : "...",
    "lastName" : "...",
    "infoTourEnabled" : true,
    "externalId" : "..."
  }, {
    "guid" : "...",
    "login" : "...",
    "firstName" : "...",
    "lastName" : "...",
    "infoTourEnabled" : true,
    "externalId" : "..."
  } ],
  "defaultLdapGroup" : true,
  "defaultKeycloakGroup" : true,
  "deletable" : true
}
                
              
Response
HTTP/1.1 201 Created
Content-Type: application/json

                
{
  "guid" : "...",
  "name" : "...",
  "description" : "...",
  "deletable" : true,
  "defaultLdapGroup" : true,
  "defaultKeycloakGroup" : true,
  "users" : [ {
    "login" : "...",
    "firstName" : "...",
    "lastName" : "...",
    "lastFailedLoginIp" : "...",
    "source" : "KEYCLOAK",
    "language" : "DE",
    "active" : true,
    "infoTourEnabled" : true,
    "endpointsOrganization" : {
      "guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
      "name" : "Entity name"
    },
    "groups" : [ {
      "guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
      "name" : "Entity name"
    }, {
      "guid" : "...",
      "name" : "..."
    } ],
    "appUserSettings" : {
      "pageSize" : 12345,
      "timeFormat" : 12345
    },
    "externalId" : "...",
    "thirdPartyRestriction" : "HORIZON",
    "guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
    "lastSuccessfulLogin" : 1451649601000,
    "lastFailedLogin" : 1451677502000,
    "uiTimeZone" : "UTC"
  }, {
    "login" : "...",
    "firstName" : "...",
    "lastName" : "...",
    "lastFailedLoginIp" : "...",
    "source" : "LDAP",
    "language" : "EN",
    "active" : true,
    "infoTourEnabled" : true,
    "endpointsOrganization" : {
      "guid" : "...",
      "name" : "..."
    },
    "groups" : [ {
      "guid" : "...",
      "name" : "..."
    }, {
      "guid" : "...",
      "name" : "..."
    } ],
    "appUserSettings" : {
      "pageSize" : 12345,
      "timeFormat" : 12345
    },
    "externalId" : "...",
    "thirdPartyRestriction" : "NO_RESTRICTION",
    "guid" : "...",
    "lastSuccessfulLogin" : 12345,
    "lastFailedLogin" : 12345,
    "uiTimeZone" : "..."
  } ],
  "roles" : [ {
    "guid" : "...",
    "name" : "...",
    "description" : "...",
    "deletable" : true,
    "privileges" : [ "STORAGE_INSTANCE_RESTORE_TASK_REGISTER", "VE_INVENTORY_SYNC_TASK_REGISTER" ],
    "isRootAccess" : true,
    "privilegeContexts" : [ {
      "type" : "HYPERVISOR",
      "instanceGuid" : "...",
      "instanceUuid" : "...",
      "instanceName" : "..."
    }, {
      "type" : "HYPERVISOR_MANAGER",
      "instanceGuid" : "...",
      "instanceUuid" : "...",
      "instanceName" : "..."
    } ]
  }, {
    "guid" : "...",
    "name" : "...",
    "description" : "...",
    "deletable" : true,
    "privileges" : [ "CONFIGURATION_WIZARD", "NODE_READ" ],
    "isRootAccess" : true,
    "privilegeContexts" : [ {
      "type" : "HYPERVISOR_MANAGER",
      "instanceGuid" : "...",
      "instanceUuid" : "...",
      "instanceName" : "..."
    }, {
      "type" : "CLOUD_SERVICE_PROVIDER",
      "instanceGuid" : "...",
      "instanceUuid" : "...",
      "instanceName" : "..."
    } ]
  } ]
}
                
              

DELETE /groups/{guid}

Remove group.

Request Parameters
name type description
guid path specify local unique identifier for group (use by vProtect)

Example

Request
DELETE /groups/{guid}
Content-Type: */*

                
...
                
              
Response
HTTP/1.1 204 No Content

              

GET /groups/{guid}

Get a single group.

Request Parameters
name type description
guid path specify local unique identifier for group (use by vProtect)
Response Body
media type data type description
application/json AppUserGroupDetails (JSON) a single group details

Example

Request
GET /groups/{guid}
Content-Type: */*
Accept: application/json

                
...
                
              
Response
HTTP/1.1 200 OK
Content-Type: application/json

                
{
  "guid" : "...",
  "name" : "...",
  "description" : "...",
  "deletable" : true,
  "defaultLdapGroup" : true,
  "defaultKeycloakGroup" : true,
  "users" : [ {
    "login" : "...",
    "firstName" : "...",
    "lastName" : "...",
    "lastFailedLoginIp" : "...",
    "source" : "KEYCLOAK",
    "language" : "EN",
    "active" : true,
    "infoTourEnabled" : true,
    "endpointsOrganization" : {
      "guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
      "name" : "Entity name"
    },
    "groups" : [ {
      "guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
      "name" : "Entity name"
    }, {
      "guid" : "...",
      "name" : "..."
    } ],
    "appUserSettings" : {
      "pageSize" : 12345,
      "timeFormat" : 12345
    },
    "externalId" : "...",
    "thirdPartyRestriction" : "NO_RESTRICTION",
    "guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
    "lastSuccessfulLogin" : 1451649601000,
    "lastFailedLogin" : 1451677502000,
    "uiTimeZone" : "UTC"
  }, {
    "login" : "...",
    "firstName" : "...",
    "lastName" : "...",
    "lastFailedLoginIp" : "...",
    "source" : "LOCAL",
    "language" : "PL",
    "active" : true,
    "infoTourEnabled" : true,
    "endpointsOrganization" : {
      "guid" : "...",
      "name" : "..."
    },
    "groups" : [ {
      "guid" : "...",
      "name" : "..."
    }, {
      "guid" : "...",
      "name" : "..."
    } ],
    "appUserSettings" : {
      "pageSize" : 12345,
      "timeFormat" : 12345
    },
    "externalId" : "...",
    "thirdPartyRestriction" : "HORIZON",
    "guid" : "...",
    "lastSuccessfulLogin" : 12345,
    "lastFailedLogin" : 12345,
    "uiTimeZone" : "..."
  } ],
  "roles" : [ {
    "guid" : "...",
    "name" : "...",
    "description" : "...",
    "deletable" : true,
    "privileges" : [ "VE_BACKUP_SLA_WRITE", "BACKUPDEST_CLEAN_OLD_BACKUPS" ],
    "isRootAccess" : true,
    "privilegeContexts" : [ {
      "type" : "CLOUD_GROUP",
      "instanceGuid" : "...",
      "instanceUuid" : "...",
      "instanceName" : "..."
    }, {
      "type" : "ROOT",
      "instanceGuid" : "...",
      "instanceUuid" : "...",
      "instanceName" : "..."
    } ]
  }, {
    "guid" : "...",
    "name" : "...",
    "description" : "...",
    "deletable" : true,
    "privileges" : [ "VE_INSTANCE_READ", "CLOUD_SERVICE_PROVIDER_WRITE" ],
    "isRootAccess" : true,
    "privilegeContexts" : [ {
      "type" : "CLOUD_USER",
      "instanceGuid" : "...",
      "instanceUuid" : "...",
      "instanceName" : "..."
    }, {
      "type" : "CLOUD_SITE",
      "instanceGuid" : "...",
      "instanceUuid" : "...",
      "instanceName" : "..."
    } ]
  } ]
}
                
              

PUT /groups/{guid}

Change group details.

Request Parameters
name type description
guid path
Request Body
media type data type description
application/json AppUserGroupRequest (JSON) specify group details to update
Response Body
media type data type description
application/json AppUserGroupDetails (JSON) updated details of group

Example

Request
PUT /groups/{guid}
Content-Type: application/json
Accept: application/json

                
{
  "guid" : "...",
  "name" : "...",
  "description" : "...",
  "roles" : [ {
    "guid" : "...",
    "name" : "...",
    "description" : "...",
    "deletable" : true,
    "privileges" : [ "OS_INSTANCE_IMPORT_TASK_REGISTER", "VE_INSTANCE_RESTORE_TO_NODE_TASK_REGISTER" ],
    "privilegeContexts" : [ {
      "type" : "ROOT",
      "instanceGuid" : "...",
      "instanceUuid" : "...",
      "instanceName" : "..."
    }, {
      "type" : "HYPERVISOR",
      "instanceGuid" : "...",
      "instanceUuid" : "...",
      "instanceName" : "..."
    } ],
    "isRootAccess" : true
  }, {
    "guid" : "...",
    "name" : "...",
    "description" : "...",
    "deletable" : true,
    "privileges" : [ "VE_INSTANCE_MOUNT_TASK_REGISTER", "APP_INSTANCE_RESTORE_TO_NODE_TASK_REGISTER" ],
    "privilegeContexts" : [ {
      "type" : "PROJECT",
      "instanceGuid" : "...",
      "instanceUuid" : "...",
      "instanceName" : "..."
    }, {
      "type" : "VIRTUAL_ENVIRONMENT",
      "instanceGuid" : "...",
      "instanceUuid" : "...",
      "instanceName" : "..."
    } ],
    "isRootAccess" : true
  } ],
  "users" : [ {
    "guid" : "...",
    "login" : "...",
    "firstName" : "...",
    "lastName" : "...",
    "infoTourEnabled" : true,
    "externalId" : "..."
  }, {
    "guid" : "...",
    "login" : "...",
    "firstName" : "...",
    "lastName" : "...",
    "infoTourEnabled" : true,
    "externalId" : "..."
  } ],
  "defaultLdapGroup" : true,
  "defaultKeycloakGroup" : true,
  "deletable" : true
}
                
              
Response
HTTP/1.1 204 No Content
Content-Type: application/json

                
{
  "guid" : "...",
  "name" : "...",
  "description" : "...",
  "deletable" : true,
  "defaultLdapGroup" : true,
  "defaultKeycloakGroup" : true,
  "users" : [ {
    "login" : "...",
    "firstName" : "...",
    "lastName" : "...",
    "lastFailedLoginIp" : "...",
    "source" : "KEYCLOAK",
    "language" : "FR",
    "active" : true,
    "infoTourEnabled" : true,
    "endpointsOrganization" : {
      "guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
      "name" : "Entity name"
    },
    "groups" : [ {
      "guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
      "name" : "Entity name"
    }, {
      "guid" : "...",
      "name" : "..."
    } ],
    "appUserSettings" : {
      "pageSize" : 12345,
      "timeFormat" : 12345
    },
    "externalId" : "...",
    "thirdPartyRestriction" : "HORIZON",
    "guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
    "lastSuccessfulLogin" : 1451649601000,
    "lastFailedLogin" : 1451677502000,
    "uiTimeZone" : "UTC"
  }, {
    "login" : "...",
    "firstName" : "...",
    "lastName" : "...",
    "lastFailedLoginIp" : "...",
    "source" : "LOCAL",
    "language" : "EN",
    "active" : true,
    "infoTourEnabled" : true,
    "endpointsOrganization" : {
      "guid" : "...",
      "name" : "..."
    },
    "groups" : [ {
      "guid" : "...",
      "name" : "..."
    }, {
      "guid" : "...",
      "name" : "..."
    } ],
    "appUserSettings" : {
      "pageSize" : 12345,
      "timeFormat" : 12345
    },
    "externalId" : "...",
    "thirdPartyRestriction" : "HORIZON",
    "guid" : "...",
    "lastSuccessfulLogin" : 12345,
    "lastFailedLogin" : 12345,
    "uiTimeZone" : "..."
  } ],
  "roles" : [ {
    "guid" : "...",
    "name" : "...",
    "description" : "...",
    "deletable" : true,
    "privileges" : [ "OS_INSTANCE_READ", "BACKUPDEST_CLEAN_OLD_BACKUPS" ],
    "isRootAccess" : true,
    "privilegeContexts" : [ {
      "type" : "HYPERVISOR",
      "instanceGuid" : "...",
      "instanceUuid" : "...",
      "instanceName" : "..."
    }, {
      "type" : "DATA_CENTER",
      "instanceGuid" : "...",
      "instanceUuid" : "...",
      "instanceName" : "..."
    } ]
  }, {
    "guid" : "...",
    "name" : "...",
    "description" : "...",
    "deletable" : true,
    "privileges" : [ "OS_REPORTING_VIEW", "CLOUD_REPORTING_VIEW" ],
    "isRootAccess" : true,
    "privilegeContexts" : [ {
      "type" : "CLOUD_SITE",
      "instanceGuid" : "...",
      "instanceUuid" : "...",
      "instanceName" : "..."
    }, {
      "type" : "CLOUD_SERVICE_PROVIDER",
      "instanceGuid" : "...",
      "instanceUuid" : "...",
      "instanceName" : "..."
    } ]
  } ]
}
                
              

POST /groups/{guid}/roles/add

Add roles to the group

Request Parameters
name type description
guid path specify group guid
Request Body
media type data type
application/json array of StringDTO (JSON)
Response Body
media type data type description
application/json AppUserGroupDetails (JSON) details of a newly created group

Example

Request
POST /groups/{guid}/roles/add
Content-Type: application/json
Accept: application/json

                
[ {
  "value" : "..."
} ]
                
              
Response
HTTP/1.1 201 Created
Content-Type: application/json

                
{
  "guid" : "...",
  "name" : "...",
  "description" : "...",
  "deletable" : true,
  "defaultLdapGroup" : true,
  "defaultKeycloakGroup" : true,
  "users" : [ {
    "login" : "...",
    "firstName" : "...",
    "lastName" : "...",
    "lastFailedLoginIp" : "...",
    "source" : "LDAP",
    "language" : "ES",
    "active" : true,
    "infoTourEnabled" : true,
    "endpointsOrganization" : {
      "guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
      "name" : "Entity name"
    },
    "groups" : [ {
      "guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
      "name" : "Entity name"
    }, {
      "guid" : "...",
      "name" : "..."
    } ],
    "appUserSettings" : {
      "pageSize" : 12345,
      "timeFormat" : 12345
    },
    "externalId" : "...",
    "thirdPartyRestriction" : "NO_RESTRICTION",
    "guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
    "lastSuccessfulLogin" : 1451649601000,
    "lastFailedLogin" : 1451677502000,
    "uiTimeZone" : "UTC"
  }, {
    "login" : "...",
    "firstName" : "...",
    "lastName" : "...",
    "lastFailedLoginIp" : "...",
    "source" : "LDAP",
    "language" : "FR",
    "active" : true,
    "infoTourEnabled" : true,
    "endpointsOrganization" : {
      "guid" : "...",
      "name" : "..."
    },
    "groups" : [ {
      "guid" : "...",
      "name" : "..."
    }, {
      "guid" : "...",
      "name" : "..."
    } ],
    "appUserSettings" : {
      "pageSize" : 12345,
      "timeFormat" : 12345
    },
    "externalId" : "...",
    "thirdPartyRestriction" : "NO_RESTRICTION",
    "guid" : "...",
    "lastSuccessfulLogin" : 12345,
    "lastFailedLogin" : 12345,
    "uiTimeZone" : "..."
  } ],
  "roles" : [ {
    "guid" : "...",
    "name" : "...",
    "description" : "...",
    "deletable" : true,
    "privileges" : [ "APP_INSTANCE_RESTORE_TASK_REGISTER", "STORAGE_SNAPSHOT_SLA_READ" ],
    "isRootAccess" : true,
    "privilegeContexts" : [ {
      "type" : "CLUSTER",
      "instanceGuid" : "...",
      "instanceUuid" : "...",
      "instanceName" : "..."
    }, {
      "type" : "DATA_CENTER",
      "instanceGuid" : "...",
      "instanceUuid" : "...",
      "instanceName" : "..."
    } ]
  }, {
    "guid" : "...",
    "name" : "...",
    "description" : "...",
    "deletable" : true,
    "privileges" : [ "OS_INSTANCE_EXPORT_TASK_REGISTER", "APP_INSTANCE_RESTORE_TO_NODE_TASK_REGISTER" ],
    "isRootAccess" : true,
    "privilegeContexts" : [ {
      "type" : "APPLICATION",
      "instanceGuid" : "...",
      "instanceUuid" : "...",
      "instanceName" : "..."
    }, {
      "type" : "STORAGE",
      "instanceGuid" : "...",
      "instanceUuid" : "...",
      "instanceName" : "..."
    } ]
  } ]
}
                
              

POST /groups/{guid}/roles/remove

Add users to the group

Request Parameters
name type description
guid path specify group guid
Request Body
media type data type
application/json array of StringDTO (JSON)
Response Body
media type data type description
application/json AppUserGroupDetails (JSON) details of a newly created group

Example

Request
POST /groups/{guid}/roles/remove
Content-Type: application/json
Accept: application/json

                
[ {
  "value" : "..."
} ]
                
              
Response
HTTP/1.1 201 Created
Content-Type: application/json

                
{
  "guid" : "...",
  "name" : "...",
  "description" : "...",
  "deletable" : true,
  "defaultLdapGroup" : true,
  "defaultKeycloakGroup" : true,
  "users" : [ {
    "login" : "...",
    "firstName" : "...",
    "lastName" : "...",
    "lastFailedLoginIp" : "...",
    "source" : "LOCAL",
    "language" : "CN",
    "active" : true,
    "infoTourEnabled" : true,
    "endpointsOrganization" : {
      "guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
      "name" : "Entity name"
    },
    "groups" : [ {
      "guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
      "name" : "Entity name"
    }, {
      "guid" : "...",
      "name" : "..."
    } ],
    "appUserSettings" : {
      "pageSize" : 12345,
      "timeFormat" : 12345
    },
    "externalId" : "...",
    "thirdPartyRestriction" : "HORIZON",
    "guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
    "lastSuccessfulLogin" : 1451649601000,
    "lastFailedLogin" : 1451677502000,
    "uiTimeZone" : "UTC"
  }, {
    "login" : "...",
    "firstName" : "...",
    "lastName" : "...",
    "lastFailedLoginIp" : "...",
    "source" : "LDAP",
    "language" : "EN",
    "active" : true,
    "infoTourEnabled" : true,
    "endpointsOrganization" : {
      "guid" : "...",
      "name" : "..."
    },
    "groups" : [ {
      "guid" : "...",
      "name" : "..."
    }, {
      "guid" : "...",
      "name" : "..."
    } ],
    "appUserSettings" : {
      "pageSize" : 12345,
      "timeFormat" : 12345
    },
    "externalId" : "...",
    "thirdPartyRestriction" : "NO_RESTRICTION",
    "guid" : "...",
    "lastSuccessfulLogin" : 12345,
    "lastFailedLogin" : 12345,
    "uiTimeZone" : "..."
  } ],
  "roles" : [ {
    "guid" : "...",
    "name" : "...",
    "description" : "...",
    "deletable" : true,
    "privileges" : [ "OS_CREDENTIAL_WRITE", "MGMT_RBAC_ACCESS_WRITE" ],
    "isRootAccess" : true,
    "privilegeContexts" : [ {
      "type" : "CLOUD_SITE",
      "instanceGuid" : "...",
      "instanceUuid" : "...",
      "instanceName" : "..."
    }, {
      "type" : "APP_CMD_EXEC_CONFIG",
      "instanceGuid" : "...",
      "instanceUuid" : "...",
      "instanceName" : "..."
    } ]
  }, {
    "guid" : "...",
    "name" : "...",
    "description" : "...",
    "deletable" : true,
    "privileges" : [ "NODE_DELETE", "OS_BACKUP_SLA_WRITE" ],
    "isRootAccess" : true,
    "privilegeContexts" : [ {
      "type" : "CLUSTER",
      "instanceGuid" : "...",
      "instanceUuid" : "...",
      "instanceName" : "..."
    }, {
      "type" : "STORAGE_PROVIDER",
      "instanceGuid" : "...",
      "instanceUuid" : "...",
      "instanceName" : "..."
    } ]
  } ]
}
                
              

POST /groups/{guid}/users/add

Add users to the group

Request Parameters
name type description
guid path specify group guid
Request Body
media type data type
application/json array of StringDTO (JSON)
Response Body
media type data type description
application/json AppUserGroupDetails (JSON) details of a newly created group

Example

Request
POST /groups/{guid}/users/add
Content-Type: application/json
Accept: application/json

                
[ {
  "value" : "..."
} ]
                
              
Response
HTTP/1.1 201 Created
Content-Type: application/json

                
{
  "guid" : "...",
  "name" : "...",
  "description" : "...",
  "deletable" : true,
  "defaultLdapGroup" : true,
  "defaultKeycloakGroup" : true,
  "users" : [ {
    "login" : "...",
    "firstName" : "...",
    "lastName" : "...",
    "lastFailedLoginIp" : "...",
    "source" : "KEYCLOAK",
    "language" : "FR",
    "active" : true,
    "infoTourEnabled" : true,
    "endpointsOrganization" : {
      "guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
      "name" : "Entity name"
    },
    "groups" : [ {
      "guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
      "name" : "Entity name"
    }, {
      "guid" : "...",
      "name" : "..."
    } ],
    "appUserSettings" : {
      "pageSize" : 12345,
      "timeFormat" : 12345
    },
    "externalId" : "...",
    "thirdPartyRestriction" : "HORIZON",
    "guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
    "lastSuccessfulLogin" : 1451649601000,
    "lastFailedLogin" : 1451677502000,
    "uiTimeZone" : "UTC"
  }, {
    "login" : "...",
    "firstName" : "...",
    "lastName" : "...",
    "lastFailedLoginIp" : "...",
    "source" : "LDAP",
    "language" : "JA",
    "active" : true,
    "infoTourEnabled" : true,
    "endpointsOrganization" : {
      "guid" : "...",
      "name" : "..."
    },
    "groups" : [ {
      "guid" : "...",
      "name" : "..."
    }, {
      "guid" : "...",
      "name" : "..."
    } ],
    "appUserSettings" : {
      "pageSize" : 12345,
      "timeFormat" : 12345
    },
    "externalId" : "...",
    "thirdPartyRestriction" : "HORIZON",
    "guid" : "...",
    "lastSuccessfulLogin" : 12345,
    "lastFailedLogin" : 12345,
    "uiTimeZone" : "..."
  } ],
  "roles" : [ {
    "guid" : "...",
    "name" : "...",
    "description" : "...",
    "deletable" : true,
    "privileges" : [ "VE_INFRASTRUCTURE_READ", "VE_REPORTING_SEND_EMAIL" ],
    "isRootAccess" : true,
    "privilegeContexts" : [ {
      "type" : "DATA_CENTER",
      "instanceGuid" : "...",
      "instanceUuid" : "...",
      "instanceName" : "..."
    }, {
      "type" : "CLOUD_USER",
      "instanceGuid" : "...",
      "instanceUuid" : "...",
      "instanceName" : "..."
    } ]
  }, {
    "guid" : "...",
    "name" : "...",
    "description" : "...",
    "deletable" : true,
    "privileges" : [ "MGMT_RBAC_ACCESS_READ", "OS_CREDENTIAL_WRITE" ],
    "isRootAccess" : true,
    "privilegeContexts" : [ {
      "type" : "OS_AGENT",
      "instanceGuid" : "...",
      "instanceUuid" : "...",
      "instanceName" : "..."
    }, {
      "type" : "VIRTUAL_ENVIRONMENT",
      "instanceGuid" : "...",
      "instanceUuid" : "...",
      "instanceName" : "..."
    } ]
  } ]
}
                
              

POST /groups/{guid}/users/remove

Add users to the group

Request Parameters
name type description
guid path specify group guid
Request Body
media type data type
application/json array of StringDTO (JSON)
Response Body
media type data type description
application/json AppUserGroupDetails (JSON) details of a newly created group

Example

Request
POST /groups/{guid}/users/remove
Content-Type: application/json
Accept: application/json

                
[ {
  "value" : "..."
} ]
                
              
Response
HTTP/1.1 201 Created
Content-Type: application/json

                
{
  "guid" : "...",
  "name" : "...",
  "description" : "...",
  "deletable" : true,
  "defaultLdapGroup" : true,
  "defaultKeycloakGroup" : true,
  "users" : [ {
    "login" : "...",
    "firstName" : "...",
    "lastName" : "...",
    "lastFailedLoginIp" : "...",
    "source" : "LOCAL",
    "language" : "CN",
    "active" : true,
    "infoTourEnabled" : true,
    "endpointsOrganization" : {
      "guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
      "name" : "Entity name"
    },
    "groups" : [ {
      "guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
      "name" : "Entity name"
    }, {
      "guid" : "...",
      "name" : "..."
    } ],
    "appUserSettings" : {
      "pageSize" : 12345,
      "timeFormat" : 12345
    },
    "externalId" : "...",
    "thirdPartyRestriction" : "NO_RESTRICTION",
    "guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
    "lastSuccessfulLogin" : 1451649601000,
    "lastFailedLogin" : 1451677502000,
    "uiTimeZone" : "UTC"
  }, {
    "login" : "...",
    "firstName" : "...",
    "lastName" : "...",
    "lastFailedLoginIp" : "...",
    "source" : "LOCAL",
    "language" : "ES",
    "active" : true,
    "infoTourEnabled" : true,
    "endpointsOrganization" : {
      "guid" : "...",
      "name" : "..."
    },
    "groups" : [ {
      "guid" : "...",
      "name" : "..."
    }, {
      "guid" : "...",
      "name" : "..."
    } ],
    "appUserSettings" : {
      "pageSize" : 12345,
      "timeFormat" : 12345
    },
    "externalId" : "...",
    "thirdPartyRestriction" : "HORIZON",
    "guid" : "...",
    "lastSuccessfulLogin" : 12345,
    "lastFailedLogin" : 12345,
    "uiTimeZone" : "..."
  } ],
  "roles" : [ {
    "guid" : "...",
    "name" : "...",
    "description" : "...",
    "deletable" : true,
    "privileges" : [ "STORAGE_SNAPSHOT_SLA_WRITE", "CLOUD_REPORTING_VIEW" ],
    "isRootAccess" : true,
    "privilegeContexts" : [ {
      "type" : "APP_CMD_EXEC_CONFIG",
      "instanceGuid" : "...",
      "instanceUuid" : "...",
      "instanceName" : "..."
    }, {
      "type" : "CLUSTER",
      "instanceGuid" : "...",
      "instanceUuid" : "...",
      "instanceName" : "..."
    } ]
  }, {
    "guid" : "...",
    "name" : "...",
    "description" : "...",
    "deletable" : true,
    "privileges" : [ "CLOUD_INSTANCE_IMPORT_TASK_REGISTER", "VE_SNAPSHOT_SLA_WRITE" ],
    "isRootAccess" : true,
    "privilegeContexts" : [ {
      "type" : "CLOUD_TEAM",
      "instanceGuid" : "...",
      "instanceUuid" : "...",
      "instanceName" : "..."
    }, {
      "type" : "CLOUD_SITE",
      "instanceGuid" : "...",
      "instanceUuid" : "...",
      "instanceName" : "..."
    } ]
  } ]
}