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

/AppSpiderEnterprise/rest/v1/Group/GetGroups

Description

Retrieves a list of Groups.

Parameters

No parameters

Response Messages

Response Status CodeReasonDescription
200SuccessResponse 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" ] }

/AppSpiderEnterprise/rest/v1/Group/GetGroup?groupName=<insert groupName>

Description

Retrieves a group by name

Parameters

NameTypeRequiredDescription
groupNamestringYGroup Name

Response Messages

Response Status CodeReasonDescription
200SuccessResponse contains Group info
400Required parameters not provided
400NotFoundNo 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" ] }

/AppSpiderEnterprise/rest/v1/Group/GetGroup?GroupId=<insert groupid>

Description

Retrieves a group by id.

Parameters

NameTypeRequiredDescription
groupIdguidYGroup Id

Response Messages

Response Status CodeReasonDescription
200SuccessResponse contains Group info
400Required parameters not provided
400NotFoundNo 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" ] }

/AppSpiderEnterprise/rest/v1/Group/AddGroup

Description

Add a new group.

Parameters

NameTypeRequiredDescription
GroupNamestringYGroup Name
ClientIdguidYClient Id
AccountsarrayNAccounts to add to group
UserIdstringNUser Id within (Accounts)
UserNamestringNUser Name within (Accounts)
ClientIdguidNClient of user within (Account)
RolesarrayYRoles to add to groups
RoleIdguidYRole Id within (Roles)
RoleNamestringYRole 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 CodeReasonDescription
200SuccessGroup added
400Required 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" ] }

/AppSpiderEnterprise/rest/v1/Group/UpdateGroup?groupId<insert groupid>

Description

Add a new group.

Parameters

NameTypeRequiredDescription
GroupIdguidYrequest parameter Group Id to update
GroupNamestringYGroup Name
ClientIdguidYClient Id of group
AccountsarrayNAccounts to add to group
UserIdstringNUser Id within (Accounts)
UserNamestringNUser Name within (Accounts)
ClientIdguidNClient of user within (Account)
RolesarrayYRoles to add to groups
RoleIdguidYRole Id within (Roles)
RoleNamestringYRole 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 CodeReasonDescription
200SuccessGroup Updated
400Required 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" ] }

/AppSpiderEnterprise/rest/v1/Group/DeleteGroup?groupId<insert groupid>

Description

Delete a group

Parameters

No parameters

Response Messages

Response Status CodeReasonDescription
200SuccessGroup 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" ] }