Group Operations
❌
Credential Warning
Note: Sys Admin or Client Admin account permissions required to execute group operations. Sys Admin have full control over groups Client Admin can only administer groups within their client
get /AppSpiderEnterprise/rest/v1/Group/GetGroups
Description
Retrieves a list of Groups.
Parameters
No parameters
Response Messages
| Response Status Code | Reason | Description |
|---|---|---|
| 200 | Success | Response contains the list of Groups |
Response example:
{
"type": "object",
"properties": {
"Groups": {
"type": "array",
"items": [
{
"type": "object",
"properties": {
"GroupId": {
"type": "string"
},
"GroupName": {
"type": "string"
}
},
"required": [
"GroupId",
"GroupName"
]
}
]
},
"IsSuccess": {
"type": "boolean"
},
"Reason": {
"type": "null"
},
"ErrorMessage": {
"type": "null"
},
"Links": {
"type": "array",
"items": [
{
"type": "object",
"properties": {
"Rel": {
"type": "string"
},
"Href": {
"type": "string"
}
},
"required": [
"Rel",
"Href"
]
}
]
}
},
"required": [
"Groups",
"IsSuccess",
"Reason",
"ErrorMessage",
"Links"
]
}get /AppSpiderEnterprise/rest/v1/Group/GetGroup?groupName=<insert groupName>
Description
Retrieves a group by name
Parameters
| Name | Type | Required | Description |
|---|---|---|---|
| groupName | string | Y | Group Name |
Response Messages
| Response Status Code | Reason | Description |
|---|---|---|
| 200 | Success | Response contains Group info |
| 400 | Required parameters not provided | |
| 400 | NotFound | No Group Found |
Response example:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"AccountGroupDetailedInfo": {
"type": "object",
"properties": {
"Accounts": {
"type": "array",
"items": {}
},
"Roles": {
"type": "array",
"items": [
{
"type": "object",
"properties": {
"RoleId": {
"type": "string"
},
"RoleName": {
"type": "string"
}
},
"required": [
"RoleId",
"RoleName"
]
}
]
},
"GroupName": {
"type": "string"
},
"ClientId": {
"type": "string"
},
"ClientName": {
"type": "null"
},
"GroupId": {
"type": "string"
}
},
"required": [
"Accounts",
"Roles",
"GroupName",
"ClientId",
"ClientName",
"GroupId"
]
},
"IsSuccess": {
"type": "boolean"
},
"Reason": {
"type": "null"
},
"ErrorMessage": {
"type": "null"
},
"Links": {
"type": "array",
"items": [
{
"type": "object",
"properties": {
"Rel": {
"type": "string"
},
"Href": {
"type": "string"
}
},
"required": [
"Rel",
"Href"
]
}
]
}
},
"required": [
"AccountGroupDetailedInfo",
"IsSuccess",
"Reason",
"ErrorMessage",
"Links"
]
}get /AppSpiderEnterprise/rest/v1/Group/GetGroup?GroupId=<insert groupid>
Description
Retrieves a group by id.
Parameters
| Name | Type | Required | Description |
|---|---|---|---|
| groupId | guid | Y | Group Id |
Response Messages
| Response Status Code | Reason | Description |
|---|---|---|
| 200 | Success | Response contains Group info |
| 400 | Required parameters not provided | |
| 400 | NotFound | No Group Found |
Response example:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"AccountGroupDetailedInfo": {
"type": "object",
"properties": {
"Accounts": {
"type": "array",
"items": {}
},
"Roles": {
"type": "array",
"items": [
{
"type": "object",
"properties": {
"RoleId": {
"type": "string"
},
"RoleName": {
"type": "string"
}
},
"required": [
"RoleId",
"RoleName"
]
}
]
},
"GroupName": {
"type": "string"
},
"ClientId": {
"type": "string"
},
"ClientName": {
"type": "null"
},
"GroupId": {
"type": "string"
}
},
"required": [
"Accounts",
"Roles",
"GroupName",
"ClientId",
"ClientName",
"GroupId"
]
},
"IsSuccess": {
"type": "boolean"
},
"Reason": {
"type": "null"
},
"ErrorMessage": {
"type": "null"
},
"Links": {
"type": "array",
"items": [
{
"type": "object",
"properties": {
"Rel": {
"type": "string"
},
"Href": {
"type": "string"
}
},
"required": [
"Rel",
"Href"
]
}
]
}
},
"required": [
"AccountGroupDetailedInfo",
"IsSuccess",
"Reason",
"ErrorMessage",
"Links"
]
}post /AppSpiderEnterprise/rest/v1/Group/AddGroup
Description
Add a new group.
Parameters
| Name | Type | Required | Description |
|---|---|---|---|
| GroupName | string | Y | Group Name |
| ClientId | guid | Y | Client Id |
| Accounts | array | N | Accounts to add to group |
| UserId | string | N | User Id within (Accounts) |
| UserName | string | N | User Name within (Accounts) |
| ClientId | guid | N | Client of user within (Account) |
| Roles | array | Y | Roles to add to groups |
| RoleId | guid | Y | Role Id within (Roles) |
| RoleName | string | Y | Role Name within (Roles) |
Request example:
{
"type": "object",
"properties": {
"Accounts": {
"type": "array",
"items": [
{
"type": "object",
"properties": {
"UserId": {
"type": "string"
},
"UserName": {
"type": "string"
},
"ClientId": {
"type": "string"
}
},
"required": [
"UserId",
"UserName",
"ClientId"
]
}
]
},
"Roles": {
"type": "array",
"items": [
{
"type": "object",
"properties": {
"RoleId": {
"type": "string"
},
"RoleName": {
"type": "string"
}
},
"required": [
"RoleId",
"RoleName"
]
}
]
},
"GroupName": {
"type": "string"
},
"ClientId": {
"type": "string"
}
},
"required": [
"Accounts",
"Roles",
"GroupName",
"ClientId"
]
}Response Messages
| Response Status Code | Reason | Description |
|---|---|---|
| 200 | Success | Group added |
| 400 | Required parameters not provided |
Response example:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"AccountGroupDetailedInfo": {
"type": "object",
"properties": {
"GroupId": {
"type": "string"
}
},
"required": [
"GroupId"
]
},
"IsSuccess": {
"type": "boolean"
},
"Reason": {
"type": "null"
},
"ErrorMessage": {
"type": "null"
},
"Links": {
"type": "array",
"items": [
{
"type": "object",
"properties": {
"Rel": {
"type": "string"
},
"Href": {
"type": "string"
}
},
"required": [
"Rel",
"Href"
]
}
]
}
},
"required": [
"AccountGroupDetailedInfo",
"IsSuccess",
"Reason",
"ErrorMessage",
"Links"
]
}put /AppSpiderEnterprise/rest/v1/Group/UpdateGroup?groupId<insert groupid>
Description
Add a new group.
Parameters
| Name | Type | Required | Description |
|---|---|---|---|
| GroupId | guid | Y | request parameter Group Id to update |
| GroupName | string | Y | Group Name |
| ClientId | guid | Y | Client Id of group |
| Accounts | array | N | Accounts to add to group |
| UserId | string | N | User Id within (Accounts) |
| UserName | string | N | User Name within (Accounts) |
| ClientId | guid | N | Client of user within (Account) |
| Roles | array | Y | Roles to add to groups |
| RoleId | guid | Y | Role Id within (Roles) |
| RoleName | string | Y | Role Name within (Roles) |
Request example:
{
"type": "object",
"properties": {
"Accounts": {
"type": "array",
"items": [
{
"type": "object",
"properties": {
"UserId": {
"type": "string"
},
"UserName": {
"type": "string"
},
"ClientId": {
"type": "string"
}
},
"required": [
"UserId",
"UserName",
"ClientId"
]
}
]
},
"Roles": {
"type": "array",
"items": [
{
"type": "object",
"properties": {
"RoleId": {
"type": "string"
},
"RoleName": {
"type": "string"
}
},
"required": [
"RoleId",
"RoleName"
]
}
]
},
"GroupName": {
"type": "string"
},
"ClientId": {
"type": "string"
}
},
"required": [
"Accounts",
"Roles",
"GroupName",
"ClientId"
]
}Response Messages
| Response Status Code | Reason | Description |
|---|---|---|
| 200 | Success | Group Updated |
| 400 | Required parameters not provided |
Response example:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"AccountGroupDetailedInfo": {
"type": "object",
"properties": {
"GroupId": {
"type": "string"
}
},
"required": [
"GroupId"
]
},
"IsSuccess": {
"type": "boolean"
},
"Reason": {
"type": "null"
},
"ErrorMessage": {
"type": "null"
},
"Links": {
"type": "array",
"items": [
{
"type": "object",
"properties": {
"Rel": {
"type": "string"
},
"Href": {
"type": "string"
}
},
"required": [
"Rel",
"Href"
]
}
]
}
},
"required": [
"AccountGroupDetailedInfo",
"IsSuccess",
"Reason",
"ErrorMessage",
"Links"
]
}delete /AppSpiderEnterprise/rest/v1/Group/DeleteGroup?groupId<insert groupid>
Description
Delete a group
Parameters
No parameters
Response Messages
| Response Status Code | Reason | Description |
|---|---|---|
| 200 | Success | Group has been deleted |
Response example:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"AccountGroupDetailedInfo": {
"type": "null"
},
"IsSuccess": {
"type": "boolean"
},
"Reason": {
"type": "null"
},
"ErrorMessage": {
"type": "null"
},
"Links": {
"type": "array",
"items": [
{
"type": "object",
"properties": {
"Rel": {
"type": "string"
},
"Href": {
"type": "string"
}
},
"required": [
"Rel",
"Href"
]
}
]
}
},
"required": [
"AccountGroupDetailedInfo",
"IsSuccess",
"Reason",
"ErrorMessage",
"Links"
]
}